Organization Webhooks

Create webhook endpoint

post/api/v1/organizations/{organizationId}/webhooks

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/organizations/{organizationId}/webhooks
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

Request body

urlstring required

Target URL to receive webhooks

namestring

Display name

descriptionstring

Description

secretstring required

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

Example request

{
  "url": "https://example.com/webhooks"
}

Response

idstring required
organizationIdstring required
urlstring required
namestring
descriptionstring
environment'local' | 'qa' | 'sandbox' | 'production' required
isActiveboolean required
isDeletedboolean required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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