Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a SimilarWeb location.
similarweb_api.png

SimilarWeb

Create a SimilarWeb Destination​

  1. Click the + icon on the Nexset that will be sent to the SimilarWeb destination, and select the Send to Destination option from the menu.

  2. Select the SimilarWeb connector from the list of available destination connectors. Then, select the credential that will be used to connect to your SimilarWeb account, and click Next; or, create a new SimilarWeb credential for use in this flow.

  3. In Nexla, SimilarWeb destinations can be created using pre-built endpoint templates, which expedite destination setup for common SimilarWeb endpoints. Each template is designed specifically for the corresponding SimilarWeb endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    SimilarWeb destinations can also be configured manually, allowing you to send data to SimilarWeb endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common SimilarWeb endpoints. Each template is designed specifically for the corresponding SimilarWeb endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Subscribe events for a domain

    This endpoint template allows you to subscribe to events for a domain using records from a Nexset. Webhooks provide a way for notifications to be delivered to an external web server whenever certain events occur on SimilarWeb's API.

    • This endpoint sends data as JSON in the request body to subscribe to webhook events in your SimilarWeb account. Each record from your Nexset will be sent as a separate API request to create a webhook subscription. The request body should contain the subscription data in the format required by the SimilarWeb API. This endpoint will also create a new data source to receive webhook notifications.

    This endpoint sends data as JSON in the request body to subscribe to webhook events for a domain in your SimilarWeb account. Each record from your Nexset will be sent as a separate API request to create a webhook subscription. The request body should contain the subscription data in the format required by the SimilarWeb API, including domain information, event types, and webhook URL.

    This endpoint will automatically create a new data source to receive webhook notifications from SimilarWeb. The subscription structure must match the SimilarWeb API's expected format.

    For detailed information about webhook subscriptions, request body formats, and available subscription properties, see the SimilarWeb API documentation.

    Unsubscribe a subscription

    This endpoint template allows you to unsubscribe from a specific Webhook event by subscription ID using records from a Nexset. Use this template when you need to cancel webhook subscriptions in your SimilarWeb account.

    • Enter the subscription ID in the Subscription ID field. This should be the unique identifier of the webhook subscription you want to unsubscribe from. The subscription ID determines which subscription will be cancelled.

    This endpoint sends data as JSON in the request body to unsubscribe from a specific webhook event by subscription ID in your SimilarWeb account. Each record from your Nexset will be sent as a separate API request to cancel a webhook subscription. The request body should contain the unsubscribe data in the format required by the SimilarWeb API.

    This endpoint will automatically create a new data source to receive confirmation of the unsubscription. For detailed information about unsubscribing from webhooks, request body formats, and available subscription properties, see the SimilarWeb API documentation.

Configure Manually​

SimilarWeb destinations can be manually configured to send data to any valid SimilarWeb API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the SimilarWeb API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the SimilarWeb API from the Method pulldown menu. SimilarWeb API typically uses POST or PUT method for creating or updating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the SimilarWeb API from the Content Format pulldown menu. SimilarWeb API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the SimilarWeb API endpoint to which data will be sent in the URL field. This should be the complete URL to your SimilarWeb endpoint (e.g., https://api.similarweb.com/v1/webhooks/subscribe). Include any required path parameters in the URL. The API key will be automatically added as a URL parameter by Nexla.

Ensure the API endpoint URL is correct and accessible with your current credentials. The SimilarWeb API endpoint URL should point to the endpoint where you want to create or update resources. The endpoint URL should include the API version (/v1/) and the resource type path. The API key will be automatically added as a URL parameter. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the SimilarWeb API. The request body should contain the resource data formatted as JSON, with field names matching the SimilarWeb API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the SimilarWeb API's expected format for the specific endpoint you're using. SimilarWeb API uses specific structures for different endpoints (webhooks, subscriptions, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the SimilarWeb API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.