Create a webhook
Argorant calls your HTTPS URL when one of the events happens. The answer holds a signing secret, shown only once: every call carries X-Argorant-Signature: sha256=<hex>, the HMAC-SHA256 of the raw body with that secret. Up to 10 webhooks per account, switched off ones included. Campaign events reach the webhooks of the workspace owner and of every active team member; exports, lists and checks reach the person who started them. Included from the Pro plan.
| Cost | What it does | Key scopes |
|---|---|---|
| Free, from the Pro plan | Writes | argorant:manage_lists |
Authorization
BearerAuth Your API key from app.argorant.com/profile, sent as Authorization: Bearer <key>. A connector sign-in token (ag_mcp_...) works the same way.
In: header
Header Parameters
Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.
length <= 128Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.
^[A-Za-z0-9._-]{8,64}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://app.argorant.com/api/v1/webhooks" \ -H "Idempotency-Key: 6f1c2e7a-run-42" \ -H "Content-Type: application/json" \ -d '{ "url": "https://hooks.example.com/argorant", "events": [ "reply.positive", "email.bounced" ] }'{ "id": "41", "url": "https://hooks.example.com/argorant", "events": [ "reply.positive", "email.bounced" ], "secret": "whsec_3f9c2a7b1d4e5f60718293a4b5c6d7e8f9a0b1c2d3e4f5a6", "note": "Store this signing secret now. It is only shown once. Each delivery carries X-Argorant-Signature, which is sha256= followed by the hex HMAC-SHA256 of the raw body with this secret."}