This section contains a list of data_intake objects.
An integration can have zero (for an outbound integration) or more data_intakes (when a single integration may have multiple event notification approaches).
Each data_intake object defines the steps needed to setup and manage event notification capabilities like webhooks that are used by publisher APIs to send data to ActiveCampaign.
The name of the dataintake, must be unique across all dataintakes within the same app.
The event notification capability used by a publisher API to send data to ActiveCampaign.
Currently, we support only webhooks and the type is limited to "webhook"
The scope explains the level of the webhook. It can be one of three values based on the publisher API:
workflow level means the publisher API supports one webhook per external resource of a user account.
connection level means the publisher API supports one webhook for all the external resources of a user account.
application level means the publisher API supports one webhook which is shared by all users of the integration.
Since a webhook can deliver data for multiple resources/users when its scope is either connection or application, we require additional information (resource_id and/or account_id) to process data properly in those cases. Details below.
The resource_id field is required for webhooks with a "connection" or "application" scope. It's a !jq comand that helps the integration locate the correct field within the webhook payload to use as external resource id.
This value must be present in your webhook payload for our system to deliver data to the intended destination. The value of this field should match the resource id defined in describe_selection.
The account_id field is similar to resource_id, but only required for "application" webhooks that contain data for multiple users.
The create step defines how to create webhooks on your platform so data can flow into ActiveCampaign.
When a user updates how data are mapped from an external resource (e.g., form or landing page) to resources in ActiveCampaign, the associated webhook may need to be updated to continue receiving data. The update step defines how to update webhooks. Depending on how webhooks work in your system, this may be optional.
The delete step defines how to remove/unsubscribe from webhooks to stop receiving user submissions.
Updated 7 months ago