Webhooks

Webhooks allow you to automatically send event data from your campaign to an external system whenever specific actions occur. This makes it easy to integrate with CRMs, marketing platforms, analytics tools, or custom applications.

What is a webhook?

A webhook is an HTTP request sent to a URL you provide whenever a subscribed event occurs. The request contains information about the event so your external system can process it automatically.

For security, webhook endpoints must use HTTPS.

Creating a webhook

1. Navigate to a campaign.
2. Click Connect → Webhooks.
3. Click Add Webhook.
4. Configure the webhook settings described below.
5. Select the events you want to subscribe to.
6. Save the webhook.

Once enabled, your endpoint will receive requests whenever the selected events occur.

Webhook settings

Payload URL

The destination URL that will receive webhook requests.

Example:

https://api.example.com/webhooks/campaign-events

Content Type

Choose how the webhook payload is formatted.

JSON

application/json

Form

application/x-www-form-urlencoded

Method

Select the HTTP method used when sending webhook requests.

Available options:

• POST (recommended)
• GET

Authentication

Authentication is available when using the POST method.

None

No authentication credentials are included with the request.

Basic Authentication

Provide:

• Username
• Password

These credentials are sent using standard HTTP Basic Authentication headers.

Secret

An optional secret used to help verify webhook requests.

When editing an existing webhook, leave this field blank to keep the current secret unchanged.

Log Response Body

Enable this option to store webhook response bodies for troubleshooting and debugging purposes.

This can be useful when testing integrations or investigating delivery issues.

Active

Controls whether webhook events are delivered.

• Enabled – Events are sent normally.
• Disabled – Event delivery is paused.

Event subscriptions

Choose which events should trigger the webhook.

Only the events you select will generate webhook requests, allowing you to receive notifications only for actions relevant to your integration.

Custom payloads

By default, webhook requests include the standard event payload.

Enable Custom Payload if you want to define your own payload structure.

Data Mapping

Custom payloads are built using one or more mappings.

For each mapping, configure:

• Field Name – The name of the field sent in the payload.
• Field Mapping – A value pulled from campaign or event data.
• Custom Value – A static value you define manually.

Example

Configuration:

• email → Contact Email
• campaign_name → Campaign Name
• source → webhook

Resulting payload:

{
  "email": "user@example.com",
  "campaign_name": "Summer Promotion",
  "source": "webhook"
}

You can add multiple mappings and remove mappings at any time.

Updated on: 17/06/2026