latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Webhooks

Deliver a webhook event to a partner URL

What it does: Executes an outbound HTTP POST to the partner URL in the request body, delivering a webhook event payload on behalf of the credentialing platform. The service sets an Idempotency-Key header (SHA-256 over messageId, webhookId, and eventType) on the outbound request and, when OAuth is configured, mints an Authorization: Bearer token before dispatching.

When to use: This endpoint is an internal callback invoked by the Cloud Tasks delivery queue; it is not intended to be called directly by external API consumers.

How (preconditions and authentication): The request must include the X-Credentialing-Api-Key header with a valid key; an absent or invalid key returns 401. The body must be a JSON object containing at minimum webhookUrl (the partner's receiving endpoint) and eventType. Optional body fields include webhookId, messageId, headers (additional outbound headers), eventPayload (the event body sent to the partner), and oauthConfiguration (when absent or blank, the service falls back to static-header authentication mode). The tenant-id and user-id headers are forwarded as delivery context. A 400 is returned when the body is null or when webhookUrl or eventType is missing or blank; supply all required fields to resolve.

What you get back: On success (200) the partner endpoint returned a 2xx response and the body is {"message": "Webhook delivered successfully"}. The service performs internal exponential-backoff retries (configurable maximum) before giving up; if all retries are exhausted it returns 502 with a body of the form {"message": ..., "statusCode": ..., "error": ...}. When the dead-letter queue is enabled, an exhausted event is instead published to the DLQ and acknowledged with a 200 {"message": ..., "dlq": true} body so it can be replayed later.

post/webhooks/cloud-deliver

Headers

X-CloudTasks-TaskRetryCountstring

Zero-indexed Cloud Tasks retry count, set by Cloud Tasks on each attempt. Used to detect the final attempt and route exhausted events to the DLQ. Defaults to 0 when absent or unparseable.

tenant-idstring

Tenant identifier forwarded to the delivery service as delivery context. Optional; when omitted no tenant context is attached to the delivery.

user-idstring

User identifier for service-to-service call context. Optional; accepted for request-context propagation.

Request body

object required

Free-form Cloud Tasks delivery payload; see field descriptions above.

Response

The partner endpoint acknowledged the event with a 2xx response, or the exhausted event was published to the dead-letter queue for later replay.