For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhook automations

Send an email or text to one person whenever another app or system calls your automation's webhook URL.

A webhook automation sends an email or a text to one person each time another app or system you use calls the automation's unique webhook URL. That system sends the person's email address or phone number, and Cymbal sends them the automation. You can create one from the Emails tab or the Text tab.

Plan: Webhook automations are available on both Starter and Premium. On Starter, each webhook automation that's turned on counts toward your limit of 4 live automations. See Starter & Premium pricing.

How to create a webhook automation

1

Go to the Email tab to send an email, or the Text → Campaigns tab to send a text.

2

In Automations, select Create new.

3

In the New email automation or New text message automation dialog, choose Webhook is fired.

4

Open the Webhook fires trigger card. Copy the Webhook endpoint with the copy button, and check the Webhook example payload for the format to send.

5

Under When the webhook fires, choose whether to send right away or after a delay.

6

Write your email or text. For emails, you can start from a template or design your own.

7

Select Turn on in the top right. The automation only sends while it's on.

How to call the webhook

1

In the other app or system, set up a POST request to the webhook endpoint you copied.

2

Send a JSON body with the person to send to. For an email automation, send an email address:

{"email": "fan@example.com", "opted_in": true}

For a text automation, send a phone number:

{"phone": "+15555550123", "opted_in": true}
3

Each call sends the automation to the one person in that call. If they aren't in your contacts yet, Cymbal adds them, with Other as the source.

  • opted_in is optional. When it's true, Cymbal subscribes the same channel the automation sends on: the email address for an email automation, or the phone number for a text automation. People who already unsubscribed stay unsubscribed.

  • A call gets an error if the URL is wrong, or if the email address (for email) or phone number (for text) is missing or not valid.

  • While the automation is turned off, calls still go through without an error, but nothing is sent. Make sure the automation is on before you rely on it.

  • Webhook automations send emails or texts. They can't send Instagram DMs.

  • Text webhook automations need an active Cymbal phone number for your organization. See Phone Number Registration.

  • If your text balance can't cover a text, Cymbal skips that send. To avoid skipped sends, keep your balance topped up or turn on auto recharge.