Webhooks
Inbox can send webhooks for campaign events.
Delivery retries
Once you configure your webhook endpoint, if delivery fails, we will automatically retry for up to six hours.
Event types
| Event type | Description |
|---|---|
| targetContacted | A prospect from a campaign was contacted |
| targetFollowUpSent | A follow-up message was sent to a prospect already contacted by a campaign |
| targetReplied | A prospect replied to a campaign |
Event structure
Inbox sends an envelope describing the event and a data object containing related entities. The following properties will be present in the data field for all campaign events:
team- the relevant Inbox team/workspacecampaign- the campaign that triggered the eventaccountLink- the account linked to the teammessage- the relevant messageexternal- the relevant prospect/contact 'external user'thread- the relevant conversation thread
A note on IDs
Inbox stores two types of IDs for objects that relate to X:
id— The Inbox ID, which is the ID of the Inbox objectplatformId— The original X 'platform' ID, which is the ID of the X user, conversation, etc.
Common querying patterns
Here are some common patterns for querying the webhook payload using a tool like Zapier.