Skip to main content

WebhookSubscription

previousSecretExpiresAtdate-timenullable

While a secret rotation is in progress, when deliveries stop also being signed with the previous secret; null otherwise.

status object[]required

Delivery status for each type.

  • Array [
    • disabledReason object

    Why delivery stopped; null while active. Send PUT /webhook again to resume where it stopped.

    anyOf
    WebhookDisabledReason

    Why delivery stopped.

    FAILING: the endpoint failed every attempt for 24 hours. GONE: the endpoint answered 410 Gone. UNRESTRICTED_VISIBILITY: the account can now see every client's data, which webhooks do not serve.

    Possible values: [FAILING, GONE, UNRESTRICTED_VISIBILITY]

    stateWebhookStreamStaterequired

    Whether deliveries of this type are being sent.

    Possible values: [ACTIVE, DISABLED]

    typeWebhookDataTyperequired

    What a webhook delivers. Each type is delivered as its own ordered stream.

    Possible values: [EVENT]

  • ]
    • typesWebhookDataType[]required

    What is delivered.

    Possible values: [EVENT]

    Example: ["EVENT"]
    urlstringrequired

    HTTPS endpoint deliveries are POSTed to.

    Example: https://example.com/webhooks
    WebhookSubscription
    {
      "previousSecretExpiresAt": "2024-07-29T15:51:28.071Z",
      "status": [
        {
          "disabledReason": "FAILING",
          "state": "ACTIVE",
          "type": "EVENT"
        }
      ],
      "types": [
        "EVENT"
      ],
      "url": "https://example.com/webhooks"
    }