Skip to navigation
Admoji CRM APIWebhooks

Register webhook

View as Markdown
Register a webhook URL for an event. If no SiteID is provided, the webhook is global across the account. Retries up to 10 times with exponential backoff on failure.

Authentication

Authorizationstring

Format: ApiKey <your_key>

Headers

Idempotency-KeystringRequiredformat: "uuid"
UUID to prevent duplicate POST operations

Request

This endpoint expects an object.
EventenumRequired
Allowed values:
PayloadURLstringRequiredformat: "uri"
SiteIDintegerOptional

Scope to a site. Omit for account-wide.

Response

Webhook registered
StatusenumOptional

0 = success, 1 = validation error, 2 = internal error

Allowed values: