Sign in
webhooks

Store a new webhook

Creates a new webhook. The data required can be submitted as a JSON body or as a list of parameters. The webhook will be given a random secret.

post/v1/webhooks

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

activeboolean

Boolean to indicate if the webhook is active

titlestring string required

A title for the webhook for easy recognition.

triggersWebhookTrigger[]
responsesWebhookResponse[]
deliveriesWebhookDelivery[]
urlstring string required

The URL of the webhook. Has to start with https.

Example request

{
  "title": "Update magic mirror on new transaction",
  "triggers": [
    "STORE_TRANSACTION",
    "UPDATE_TRANSACTION"
  ],
  "responses": [
    "TRANSACTIONS"
  ],
  "deliveries": [
    "JSON"
  ],
  "url": "https://example.com"
}

Response

New webhook stored, result in response.

Changes

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