Webhook

​

Introduction

Webhooks are a way for two applications to communicate with each other in real-time. When an event occurs in one application, a webhook can be used to send a payload of data to a URL specified by the other application. The receiving application can then take action based on the data in the payload.

​

Usage

​

Supported Events

The following events are currently supported by our Webhook:

• Lead Events: lead.create, lead.update, lead.delete
• Lead Activity Events: lead.status.update, lead.list.update, lead.tags.update, lead.track, lead.task.create, lead.task.update, lead.task.delete, lead.note.create, lead.note.update, lead.note.delete
• Lead Message: lead.linkedin.new, lead.twitter.new, lead.email.new
• Campaign Events: campaign.create, campaign.update, campaign.delete
• Campaign Email Events: campaign.email.sent, campaign.email.reply, campaign.email.open, campaign.email.click, campaign.email.bounce, campaign.email.unsubscribe
• List Events: list.create, list.update, list.delete
• Status Events: status.create, status.update, status.delete
• Tag Events: tag.create, tag.update, tag.delete

​

Payload

The payload of a webhook contains the data that is being sent from one application to another. Here is a sample payload:

{
    "id_space": "eb8edc65-129a-4cb6-abbe-6bf8979c0658",
    "event": "lead.create",
    "secret": "wh_a46f35f22d9723a",
    "payload": {
        "id": "e106db1f-aba3-40ba-97a7-507b54757ef8",
        "email": null,
        "company": null,
        "notes": null,
        "phone": null,
        "linkedin_url": null,
        "created_at": "2023-04-29T11:13:55.021Z",
        "updated_at": null,
        "first_name": "Jean",
        "icebreaker": "",
        "last_name": "remove",
        "website_url": null,
        "timezone": null,
        "city": null,
        "company_role": null,
        "twitter_name": null,
        "avatar_url": null,
        "icebreaker_2": "",
        "icebreaker_3": "",
        "icebreaker_4": "",
        "email_bounce_score": null,
        "twitter_company_name": null,
        "is_deleted": false,
        "is_deleted_at": null,
        "company_enrich": null,
        "custom_fields": null,
        "custom_fields_schema": null,
        "order": 0,
        "contract_value": 0,
        "is_tracked": false,
        "id_import_task": null,
        "id_linkedin_company": null,
        "id_linkedin": null,
        "id_space": "eb8edc65-129a-4cb6-abbe-6bf8979c0658",
        "id_twitter_company": null,
        "id_twitter": null
    }
}

The payload contains the following fields:

• id_space: The ID of the space that the event occurred in.
• event: The event that occurred.
• secret: A secret value that is included in the payload to verify the source of the webhook.
• payload: The data that is being sent with the webhook. The structure of this data will depend on the event that occurred.

​

Delivery Failed

If the delivery of a webhook fails 10 times, the webhook endpoint will be paused. There is no retry policy, so it is up to the receiving application to handle any errors that occur during the delivery of a webhook.

​

Conclusion

Webhooks are a powerful tool for integrating two applications in real-time. By using webhooks, your application can respond to events as they happen and take action based on the data that is sent with the event.