Webhooks

Subscribe a target URL to a trigger event (REST Hook)

Re-subscribing the same URL and event is a no-op that returns the existing subscription id. Each delivery POSTs an envelope of the form { event, timestamp, payload }, where payload is the resource object; map payload.* rather than the top level. Deliveries are retried up to 3 times and carry an X-Webhook-Signature header (HMAC-SHA256 of the raw request body, keyed with the endpoint signing secret). This endpoint does not return that secret, so a subscription made here cannot be verified; use a long, unguessable target URL over HTTPS. Webhooks added in the AgendaForge app show their secret once, at creation.

post/api/v1/hooks

Request

  • Base URL: https://api.agendaforge.app
  • URL: https://api.agendaforge.app/api/v1/hooks
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

source'zapier' | 'make' | 'n8n'

Tags the platform the subscription belongs to. Anything other than "make" or "n8n" (including omitting the parameter) records "zapier".

Request body

event'contact.added' | 'contact.added_to_event' | 'contact.updated' | 'contact.removed' | 'sponsor.added' | 'sponsor.updated' | 'sponsor.removed' | 'session.added' | 'session.updated' | 'session.removed' | 'speaker.confirmed' | 'speaker.declined' | 'submission.created' | 'submission.status_changed' | 'review.completed' | 'event.published' required

Trigger event names accepted by POST /api/v1/hooks and GET /api/v1/triggers/{event}/sample.

targetUrlstring uri required

The http(s) URL deliveries are POSTed to.

Response

The subscription id (existing id when re-subscribing).

idstring required

Webhook subscription id.

Changes

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