Create a webhook

post/webhooks

Request

  • Base URL
    https://api.sandbox.waza.co/v2
  • URL
    https://api.sandbox.waza.co/v2/webhooks
  • Auth
    API key in header waza-x-key

Headers

waza-x-keystring

Your Waza api key

Request body

labelstring required
urlstring required

A valid and secure https:// URL

secretstring required
eventsstring[] required

At least one event type to consume

Response

200

Example response

{
  "data": {
    "id": "97f24d4a-2624-4098-8269-c1dbb30abefa",
    "label": "test",
    "url": "https://webhook.example.site",
    "secret": "1234",
    "state": "ACTIVE",
    "created_date": "2023-05-04T22:50:08.539Z",
    "updated_date": "2023-05-04T22:50:08.539Z",
    "events": [
      "order.completed"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.