Configure Webhook

POST /api/v2/webhooks

The Configure Webhook endpoint sets a webhook for a specified event_type. This means all events related to the specified event_type will be sent to the configured webhook URL. Request Body

Name	Type	Description	Required
event_type	integer	The type of the event. See List Webhook Event Types for the available event types.	True
webhook_url	string	The endpoint that will receive webhook requests. This must be a POST endpoint.	True

Sample Request

Example

{
  "event_type": 1,
  "webhook_url": "https://example.com/api/webhook"
}

Response

200

{
  "status": "success",
  "data": {
    "id": "01954751-cccd-709a-baee-ee3ddac37e39",
    "business_id": "06790d62-07e5-7aac-8000-d0462f2c2d94",
    "event_type": 1,
    "webhook_url": "https://example.com/api/webhook",
    "event_names": null,
    "ip_allowlist": null,
    "created_by": "06790d73-154f-7dae-8000-12b54a9a258a",
    "created": "2025-02-26T21:57:18.000+08:00",
    "last_modified": "2025-02-26T21:57:18.000+08:00"
  }
}