Webhook

You can configure webhook endpoints via the API to be notified about events that occur in your accounts or client accounts.

Endpoints

GET

 /webhooks

POST

 /webhooks

GET

 /webhooks/{id}

PUT

 /webhooks/{id}

DELETE

 /webhooks/{id}

PUT

 /webhooks/{id}/rotate-secret

The Webhook object

idstringrequired

The webhook's unique identifier

---

urlstring^https:\/\/[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$required

An HTTPS URL

---

enabledbooleanrequired

Determines if events should be sent to the webhook or not.

---

account_typeenumrequired

The account's type.

Enum:

• live
• test

---

account_idsarray of string

The webhook will exclusively push events which belong to account identifiers.

Acts as a filter: if not set, events belonging to all the organisation's accounts are pushed.

---

created_atstringdate-timerequired

An <a href="https://pretty-rfc.herokuapp.com/RFC3339">RFC 3339</a>-formatted timestamp.

---

secretstringrequired

The last 4 characters of the secret key used to generate the webhook payload HMAC.

Webhook

{
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "url": "https://lune.co",
  "enabled": true,
  "account_type": "live",
  "account_ids": [
    "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz"
  ],
  "created_at": "1985-04-12T23:20:50.52Z",
  "secret": "secret"
}