API Reference: The webhook model | Swell Developer Center

Fields

idobjectIdauto

The unique identifier for the webhook.

aliasstring

Alias used to refer to the webhook configuration.

apistringrequired

API the webhook subscribes to—com for the store API.

urlstringrequired

URL endpoint for the webhook.

eventsarray of stringrequired

Array of trigger events for the webhook.

enabledboolean

Determines whether the webhook is enabled. Defaults to false.

auto_disabledbooleanauto

Indicates whether the webhook was automatically disabled. This occurs when the webhook has failed for 4 days with no successful delivery in that time.

retry_disabled_eventsboolean

Determines whether the webhook retries disabled events.

attempts_failedint

The number of failed webhook attempts.

date_first_faileddateauto

The date of the webhook's first failed attempt.

date_last_successdate

Date of the last successful webhook delivery.

date_last_warneddateauto

The date of the last warning for a failed attempt.

date_final_attemptdate

The final attempt for a webhook after continuous failed attempts. Webhooks are disabled after failing for 4 days with no successful delivery.

The webhook model

{
  "url": "http://localhost:5000",
  "enabled": false,
  "alias": "webhook",
  "description": null,
  "events": [
    "order.created",
    "order.submitted",
    "order.updated"
  ],
  "api": "com",
  "date_final_attempt": null,
  "date_scheduled": null,
  "date_created": "2021-09-27T16:30:11.837Z",
  "date_updated": "2021-10-28T16:04:21.648Z",
  "id": "6151f193ae97e82ccbf6f0a7"
}