Create Webhook

POST 
/api/v2/business/:businessId/webhook

Create Webhook

Request

Path Parameters

businessId stringrequired

Created business id.

application/json

Body

required

url Urlrequired

Instance unique url.

enabled Enabled

Default value: false

Enable or disable the url.

headers object

additional headers that will make up the webhook request.

Responses

201

BusinessWebhookCreateResponse

application/json

Schema

Schema

webhookId stringrequired
url stringrequired
enabled booleanrequired
headers objectrequired

Default value: [object Object]

createdAt date-timerequired
updatedAt date-timerequired
businessBusinessId stringrequired

Example (from schema)

{
  "webhookId": "string",
  "url": "string",
  "enabled": true,
  "headers": {},
  "createdAt": "2025-06-12T13:21:06.449Z",
  "updatedAt": "2025-06-12T13:21:06.449Z",
  "businessBusinessId": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...