Add a webhook
Send your endpoint’s URL with one of the agent’s tokens:https and reachable on the public internet. The answer holds
the webhook’s secret, which starts with whsec_. Keep it on your server:
listing webhooks leaves it out, and adding the same URL again gives back the
same webhook and secret.
List webhooks shows how delivery went,
and Remove a webhook stops it.
What arrives
Each event is onePOST with a JSON body:
Check the signature
Artil signs each delivery as Standard Webhooks describes, in thewebhook-id, webhook-timestamp, and webhook-signature
headers. Check it with a Standard Webhooks library before you trust the body.
In TypeScript:
Retries
Answer with any2xx status within 5 seconds. Otherwise Artil sends the same
event again, with the same webhook-id, after about 10 seconds, 1 minute,
5 minutes, 30 minutes, 2 hours, and then every 6 hours. It gives up on an event
3 days after it happened.
Events arrive in order: while one is being retried, the ones after it wait. An
event can arrive more than once, so skip a webhook-id you have already
handled.
List webhooks shows the last
error,
how many attempts failed, and when Artil retries next in retryAt.