Webhooks

One of the integrations on the integrations page is a webhook. This is where we send events from a contact like opens, clicks, and replies.

Webhook URL

Enter a webhook url to receive events from a contact like opens, clicks, and replies.

We will send a POST request to the url you enter with a JSON payload.

Webhook Events

contact - the contact object for this event

CampaignId - the Campaign ID for this event

type - one of open, click, reply, bounce, interest, appointment, unsubscribe, finished

conversationId - the ID of the latest conversation associated with this contact (null if no conversation exists)

if you're only interested in when the interest changes, you can write some logic like this to ignore other events:

if (event.type === 'interest' && contact.interest === 'interested') {
  // do something like send this contact to your customer or CRM.
}

the contact object will have the value for interest and appointment. For interest, you want the contact.interest value (a string). For appointment, you want the contact.appointment value (a boolean).

The conversationId field contains the ID of the most recent email conversation associated with the contact. This will be null if:

• The contact doesn't have an email address
• No conversation exists for this contact yet
• The contact hasn't had any email interactions in the last year

{
  "type": "click",
  "CampaignId": "d9ff359d-8d50-378b-989a-34100a0503c1",
  "conversationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "contact": {
    "id": "345b2b81-b2cf-4879-bf46-73a33275e22b",
    "first_name": null,
    "last_name": null,
    "email": "andrew@xoxo.capital",
    "linkedin_url": "",
    "image": null,
    "title": null,
    "phone": null,
    "timezone_offset": null,
    "company_name": null,
    "industry": null,
    "note": null,
    "company_url": null,
    "one_liner": null,
    "twitter": null,
    "twitter_id": null,
    "custom": null,
    "validated": false,
    "verified": true,
    "deleted": false,
    "finished": true,
    "bounced": false,
    "interest": "interested",
    "clicked": true,
    "opened": false,
    "replied": false,
    "appointment": false,
    "failed": false,
    "state": null,
    "country": null,
    "b_test": false,
    "test_letter": "a",
    "createdAt": "2023-01-26T04:41:10.639Z",
    "updatedAt": "2023-01-26T04:48:04.762Z",
    "UserId": "19e81e73-0b7b-449c-8d58-78701c478bb8",
    "TeamId": "fd815f85-80a9-43ba-825b-dc114fa2bfcg",
    "OrgId": "d829145b-ee91-4fr9-9446-9ad392ac3e3d",
    "CampaignId": "d9ff359d-8d50-378b-989d-34100a0503c1",
    "ContactConfigId": "90736a4f-31c6-4fb7-8429-89768419312d",
    "SenderId": "1741c004-3c4a-4633-9ec1-586270332c7b",
    "Sender": {
      "id": "2744c004-3c4a-4633-9ec1-586270332c7b",
      "provider": "smtp",
      "send_as": "Andrew Pierno",
      "email": "ap@supersend.io"
    }
  }
}