How can I use webhooks with Letterhead?
Edit in CMSWebhooks are automated messages โ payloads โ delivered to a unique URL whenever a specific event occurs in Letterhead. Theyโre generally faster and require less effort than polling for changes, and let you sync Letterhead data with other apps such as CMSes, CRMs, and team chat tools.
You can send the following events from Letterhead to another app via webhook:
- Audience member created or updated
- Newsletter published
- Newsletter scheduled
- Newsletter ready for metrics
- Promotion campaign created
- Promotion campaign details updated
- Promotion campaign promotion changed
- Promotion campaign status changed
โNewsletter ready for metricsโ isnโt in the event dropdown yet when you create a webhook in the app (see below) โ contact support if youโd like it enabled for your account in the meantime.
When should I use a webhook?
Section titled โWhen should I use a webhook?โUse a webhook to trigger an action in another application based on an event in Letterhead. For example, when an audience member is created or updated, you might want them to receive a separate marketing email from your CRM โ or you might notify an advertiser when the latest edition published with their ad. For a comparison with Zapier and the API, see How can Letterhead integrate with other software?.
How do I create a webhook?
Section titled โHow do I create a webhook?โWebhooks are managed at the organization level.
- Log in and select your organization in the left-hand menu (the organization is the top option, above its channels).
- On the organization page, open Settings, then select Webhooks.
- Click Add new webhook.
- In the slide-out, select the event youโd like to track.
- Enter the endpoint (URL) โ a secure URL where Letterhead will post the payload.
- Turn on the Active toggle โ it shows a checkmark when enabled.
- Click Create. Youโll see a confirmation when the webhook is created successfully.
How can I remove a webhook?
Section titled โHow can I remove a webhook?โYou can deactivate or delete any webhook you create:
- Delete โ hover over the webhook row and click the delete icon. This permanently deactivates and removes the webhook.
- Deactivate โ click the Active toggle so the checkmark clears and the row is grayed out with an โxโ. You can re-enable it later.
Need help?
Section titled โNeed help?โContact support if you run into trouble setting up an endpoint.
Still can’t find what you need? Contact support.