Skip to main content

Create a webhook

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

An HTTPS URL

account_idsarray of string

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

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

Returns
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 secret key used to generate the webhook payload HMAC.

  • POST /webhooks
    • curl 'https://api.lune.co/v1/webhooks' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -X POST \
  -d '{
    "url": "https://lune.co",
    "account_ids": [
      "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz"
    ]
  }'
  • Response
    • {
  "id": "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz",
  "url": "https://lune.co",
  "enabled": true,
  "account_type": "live",
  "account_ids": [
    "ljmkOq7vXd239gAE9WALWQ8ZGVD5ExNz"
  ],
  "created_at": "1985-04-12T23:20:50.52Z",
  "secret": "secret"
}