Authorization

Use a server-side API key with the listed grants and permitted resource access.

webhooks:manage

Request headers

X-Api-Keyrequired: Your server-side integration credential.
Idempotency-Keyrequired: Stable key for this intended action. Reuse it for retries of the same request.
Content-Typeapplication/json: Encode the request body as JSON.

Request body

urlstring · required: Public HTTPS receiver. Ownership verification is required.
eventTypesarray · required: The eventTypes values for this request.
enabledboolean · optional: Whether the verified subscription should receive events.

Response

201Created

Returns the authorized resource or result for this operation. List results use items, nextCursor, and hasMore.

Behavior to account for

Events are delivered at least once. Deduplicate by event ID, compare resource versions, and retain a replay cursor.

Errors

Authentication failures return 401 or 403. Inaccessible resources return 404. Business and idempotency conflicts return 409. Rate limits return 429 with retry guidance.

Error handling guide

curl --request POST 'https://api.wincora.com/api/v1/tenant/webhook-subscriptions' \ --header 'X-Api-Key: YOUR_API_KEY' \ --header 'Idempotency-Key: request-example-001' \ --header 'Content-Type: application/json' \ --data '{ "url": "https://your-app.example/webhooks/wincora", "eventTypes": [ "case.action_required", "deliverable.available" ], "enabled": true }'

import os import requests response = requests.request( 'POST', 'https://api.wincora.com/api/v1/tenant/webhook-subscriptions', headers={ "X-Api-Key": os.environ["WINCORA_API_KEY"], "Idempotency-Key": "request-example-001", "Content-Type": "application/json" }, json={ "url": "https://your-app.example/webhooks/wincora", "eventTypes": [ "case.action_required", "deliverable.available" ], "enabled": True }, timeout=30, ) response.raise_for_status() result = response.json()