Organization Webhooks

Ping a webhook endpoint (creates and sends a synthetic event)

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

Request

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

Path parameters

organizationIdstring required
webhookIdstring required

Request body

dataobject

Optional additional data to include in ping payload

Response

idstring required
organizationIdstring required
merchantIdstring
typestring required
versionstring required
occurredAtstring date-time required
payloadstring required

Stringified JSON payload (redacted in read APIs)

requestIdstring
createdAtstring date-time required

Changes

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