Webhooks

Register a webhook endpoint

Secret key. Permission webhooks:write. url must be public https. The secret in the response is shown once. Deliveries are attempted once, with an 8 second timeout, and redirects are not followed: poll GET /orders?updated_since= as a backstop.

post/webhooks

Request

  • Base URL: https://sitesplaced.com/api/v1
  • URL: https://sitesplaced.com/api/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

urlstring uri required

Must be public https.

eventsWebhookEvent[]

Example request

{
  "events": [
    "order.created"
  ]
}

Response

The endpoint, with its signing secret.

idstring uuid required
urlstring uri required
eventsWebhookEvent[] required
secretstring required

Shown once.

Example response

{
  "secret": "whsec_…"
}

Changes

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