Skip to main content

Webhook

Attributes
idstringrequired

The webhook's unique identifier


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

An HTTPS URL


enabledbooleanrequired

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


account_typeenumrequired

The account's type.

See the <a href="#section/Live-and-test-accounts">Live and test accounts section</a> for details.

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.

  • Endpoints
  • 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"
    }