Webhooks

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.

CostWhat it doesKey scopes
Free, from the Pro planWritesargorant:manage_lists
post/api/v1/webhooks

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/webhooks
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

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.

X-Request-Idstring

Your 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.

Request body

urlstring uri required

Your HTTPS endpoint on the public internet.

eventsWebhookEvent[] required

Events to receive.

Example request

{
  "url": "https://hooks.example.com/argorant"
}

Response

Created

idstring
urlstring
eventsstring[]
secretstring
notestring

Changes

No recorded changes to this operation across all 1 revision of this API.