Create webhook endpoint

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

organizationIdstringRequired

This endpoint expects an object.

urlstringRequired

Target URL to receive webhooks

secretstringRequired

Endpoint secret (client-provided). Not returned by the API.

namestringOptional<=128 characters

Display name

descriptionstringOptional<=512 characters

Description

idstring

organizationIdstring

urlstring

environmentenum

Allowed values:

isActiveboolean

isDeletedboolean

createdAtdatetime

updatedAtdatetime

namestring

descriptionstring

400

Create Endpoint Request Bad Request Error

401

Create Endpoint Request Unauthorized Error

403

Create Endpoint Request Forbidden Error

500

Create Endpoint Request Internal Server Error

1	curl -X POST https://api-sandbox.koywe.com/api/v1/organizations/organizationId/webhooks \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"url": "https://example.com/webhooks",
6	"secret": "secret"
7	}'

1	{
2	"id": "id",
3	"organizationId": "organizationId",
4	"url": "url",
5	"environment": "local",
6	"isActive": true,
7	"isDeleted": true,
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z",
10	"name": "name",
11	"description": "description"
12	}