Webhooks
A webhook is an address on your own server that Automette sends a message to when something happens. Your system can then store the document, email it, or update a record, without checking Automette again and again.
Events
| Event | Sent when |
|---|---|
render.completed | A document is ready. Sent for the API, AI assistants, Zapier, forms, Dynamic URLs and automations. |
render.failed | A document could not be made. |
job.completed | A bulk run from a CSV file has finished: one message for the whole run. |
form.submitted | Someone submitted a form. |
Documents made on the Generate page or in the editor send no webhooks.
Add a webhook
- Open Webhooks in the menu and click Add endpoint.
- Paste your address under Endpoint URL.
- Under Events to receive, tick the events you want.
- Under Scope, choose All templates, or one template to hear only about its documents.
- Click Create endpoint, then copy the signing secret. It is shown once; you need it to check that messages really come from Automette.
You can also add a webhook on a template's own page, which hears about that template only, or in a form's After submit tab, which hears about that form only. Developers can add them with the webhooks API.
Check that a message is genuine
Every message carries a webhook-signature header, made with your signing secret. Your server should check it before trusting the message; the code is in Webhook payloads. The same page shows the contents of each event.
When your server does not answer
A message that gets no answer, or an error, within 10 seconds is sent again, up to 5 times in the next few minutes. After 10 failures in a row the webhook is switched off. Fix your server, then switch it back on under Webhooks. Every attempt is listed there.
A webhook for one request
A developer can instead pass webhook_url with a single API request, to hear about that one document. Those messages are not signed, and their deliveries are listed on the document in History.
Last updated on