AIMERICA
☰

Subscribe to events with webhooks

Add a webhook subscription that sends calls, texts, voicemails and other events to your server.

Video tutorial, 1:22 · English captions · Download the video

Open Developer (owners and admins), tab Webhooks. Type your server's https address, choose how many days the subscription lasts, tick the events (finished calls, texts and test pings are ticked already; live call events, voicemails, faxes, presence and recordings are there too) and press Add webhook. Your server must echo the validation token. Copy the signing secret: it is shown once.

In this video

Step by step

  1. 1

    Webhooks send events to your own server the moment they happen. In Developer, open the Webhooks tab.

    Click Webhooks
  2. 2

    These are subscriptions with a handshake, filters and an expiry. Your server must echo a validation token when you add one.

  3. 3

    Type your server's address.

    Webhook address
  4. 4

    Choose how many days it lasts before it expires.

  5. 5

    Pick the events. Finished calls, texts and test pings start ticked. There are also live calls, voicemails, faxes, presence and recordings.

    Pick the events
  6. 6

    Tick new voicemails too.

  7. 7

    Add webhook creates the subscription and shows its signing secret once. Here we stop before adding it.

    Add webhook: secret shown once
  8. 8

    Your subscriptions are listed below, with their status, events and expiry date. There are none yet on this demo.

  9. 9

    The developer site explains the handshake, how to check the signature, and the retries.

  10. 10

    The simpler webhooks Zapier uses, without a handshake, stay under Settings, Developer.

The handshake, the signature check in Python and Node, retries and filters are explained at api.a1merica.ai/webhooks. Zapier's simpler webhooks are under Settings > Company > Developer.

Was this not what you needed? Write to us.

Français