Skip to main content

Webhooks

Actito aims at offering you a wide range of connectivity options in your marketing approach. Consequently, we particularly want to enable the exchange of data between Actito and other systems related to your activity.

The Actito Public API enable you to automate interactions with Actito without needing to go through the interface.

Webhooks, on the other hand, give you the reverse service in comparison to the API. With them, it is required to make a GET call every time you need a piece of information. Webhooks are in fact listening to the information. By subscribing to Webhooks, the latter allow you to be directly notified when specific events occur on a profile or a custom table entry. These events will be pushed to the endpoint URL of your choice.

caution

This section of this documentation aim at giving you a business perspective of what's possible through the Actito Integration Framework.

For implementation details, developers should always refer to the specs in the Developers Portal

Context​

Affected events​

Webhooks allow you to get notified about events revolving around profile tables and custom tables of the data model.

These events can be of the following nature:

  • CREATE: Allows you to get notified for each profile creation or each new data record
  • UPDATE: Allows you to get notified for each modification on a profile or data record. It is possible to specify exactly which field of the table must be taken into account
  • DELETE: Allows you to get notified every time a profile or a record is deleted
  • UPDATED_SEGMENT and UPDATED_SUBSCRIPTION: These events are specific to profile tables. They allow you to get notified for every subscription and segmentation modification
Good to know

For custom tables, events must be defined in the JSON definition file of the custom table (in the "eventsToTrigger" parameter).
A CREATE event always exists by default in custom tables, but UPDATE events must be defined (notably to define updates on which fields trigger the event).
Do not hesitate to contact your account manager if you need help to set up events in your tables.

In addition to retrieving information from your tables, webhooks can also be used to get the status of your ETLs and file synchronizations, and to connect your scenarios to external systems thanks to custom actions.

Protocol​

When Actito records an event that matches the definition of the Webhook subscription, the Webhook will submit the information to the URL that you specified.

To help you manage greater loads, pushes can be made "One by one" or in "Bulk" mode. Bulk mode is useful when several events are recorded at once (such as a file import), to group the events in one push. Nevertheless, webhooks are always a real-time method to get the information: even in bulk mode, if 1 event is recorded and a 2nd eventis not recorded in a matter of seconds, the webhook notification will be pushed.

Access​

To receive notifications every time an event occurs in the table to which you are listening, it is necessary to create a subscription to a Webhook. A Webhook subscription must be created for each event and each table to which you are listening.

Creating and managing these subscriptions can be done through the Actito APIs. Their definition is available on the technical documentation.