Set up Batch Webhook Integration

Single Webhooks are sent when an event for which response data has been requested is completed. As a result, data is sent at intervals. Therefore, these webhooks are ideal for realtime campaigns.

Batch Webhooks, on the other hand, are suitable if you expect a large amount of data to come at once.

Before you begin, you should have the following information available:

  • The destination URL, method and content type

  • The username and password to be used when sending the webhook (if the destination URL requires authentication)

  • The authentication header (or other special headers if they are used for authentication)

Setting up a Batch Webhook Integration

  • In the CrossEngage app, navigate to Settings > Integrations.

  • Click the Add new integration button in the top right corner of the page.

  • Search for 'Webhook' and click Set Up.

Using this information, you can now complete the setup form.

Sender Info

The sender information is the method (POST or PUT) and Destination URL that will be used to dispatch the webhook.

Authentication

You are able to use three types of authentication when using Webhooks on CrossEngage:

  • Basic Authentication

  • Header Authentication

  • URL based authentication.

Please note that OAuth authentication is not currently supported. For more information regarding supported authentication, please reach out to your dedicated Customer Success manager or send an email to support@crossengage.io.

Content type

Choose the content type application/JSON.

Message Batching

Turn on Message Batching, and choose a batch size from 50 to 1000.

Append HTTP headers

If you require any special headers or authentication headers, please add the key - value pairs here.

Default Message Content

Since the structure of a webhook will not considerably change over the time, you can prefill the default message at this stage.

The information entered here will appear by default in every new message created on CrossEngage.

Additional Properties

You can define additional properties that will be added to events.

Last updated