Skip to content
導覽

An event, as it is posted to a webhook

Signed as Standard Webhooks signs (https://www.standardwebhooks.com): webhook-signature is v1, and the base64 of HMAC-SHA256 over <webhook-id>.<webhook-timestamp>.<the body>, keyed with the bytes the webhook's secret is the base64 of (what follows whsec_); libraries that check it exist for most languages. A delivery has succeeded when the answer's status is 2xx; another status, no connection, and no answer within 10 seconds are failures, and it is sent again 5 seconds, 5 minutes, 30 minutes, 2 hours, 5 hours, 10 hours and 10 hours later (--webhook-retry-seconds), then given up. What is to be sent is in the store: a control plane that starts again goes on with it. The same event may come twice (an answer lost on its way back is a failure here): the receiver tells by webhook-id. Sent to the address that was checked to be on the public internet, connected to by that address.

POST
eventWebhook

標頭參數

  • webhook-idstringrequired

    The event's id: the same each time it is sent.

    pattern: ^evt-[0-9a-hjkmnp-tv-z]{16}$
  • webhook-timestampstringrequired

    When it was sent, in seconds since 1970.

    pattern: ^[0-9]+$
  • webhook-signaturestringrequired

    v1,<base64>.

    pattern: ^v1,[A-Za-z0-9+/]{43}=$

請求主體JSON必填

  • idstringrequired
    pattern: ^evt-[0-9a-hjkmnp-tv-z]{16}$
  • objectstringrequired
  • typestringrequired

    Open: a type that is added later is sent to a webhook that takes every type, and a receiver lets pass what it does not know.

  • created_atstringrequired

    When the control plane recorded it.

    format: date-time
  • dataobjectrequired

    What the event is about: the schema x-events names for its type.

請求範例

{
  "id": "string",
  "object": "event",
  "type": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "data": {}
}

Returns

200

Any 2xx: delivered.

500

Anything else: sent again later, as said above.

輸入關鍵字搜尋…

↑↓ 移動↵ 選取Esc 關閉