Essence Webhook Management API

All OpenAPI documents

Version v1 · OpenAPI 3.0.1 · 11 operations · Download the JSON document

Unified webhook management platform for partner integrations

Generated from the WebhookManagement service's code at build time (api-specs/generated/WebhookManagement/Essence.Api.WebhookManagement.Api.json) and drift-checked in CI. It describes what the code registers, which is not the same as what any one deployment has routed.

Webhooks

GET/api/v1/webhooks

Gets all webhook subscriptions with pagination

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
pageNumber	query	integer (int32)	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — WebhookSubscriptionDtoPaginatedResponse

POST/api/v1/webhooks

Creates a new webhook subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• CreateWebhookSubscriptionRequest as application/*+json, application/json, text/json

Responses

201Created — CreateWebhookSubscriptionResponse

400Bad Request — ProblemDetails

POST/api/v1/webhooks/events

Triggers webhook delivery for an event (internal API)

Authentication:Bearer (the document-wide requirement)

Parameters

Takes no parameters.

Request body

Not marked as required in the document.

• TriggerWebhookEventRequest as application/*+json, application/json, text/json

Responses

202Accepted — integer (int32)

400Bad Request — ProblemDetails

GET/api/v1/webhooks/{id}

Gets a webhook subscription by ID

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

200Success — WebhookSubscriptionDto

404Not Found — ProblemDetails

PUT/api/v1/webhooks/{id}

Updates a webhook subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• UpdateWebhookSubscriptionRequest as application/*+json, application/json, text/json

Responses

204No Content

404Not Found — ProblemDetails

DELETE/api/v1/webhooks/{id}

Deletes a webhook subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

204No Content

404Not Found — ProblemDetails

GET/api/v1/webhooks/{id}/deliveries

Gets delivery logs for a webhook subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
pageNumber	query	integer (int32)	no	—
pageSize	query	integer (int32)	no	—

Request body

No request body.

Responses

200Success — WebhookDeliveryLogDto[]

404Not Found — ProblemDetails

POST/api/v1/webhooks/{id}/deliveries/redrive

Re-drives (replays) this subscription's dead-lettered deliveries — FR-08.058, debt-2026-08-20-044. Scoped to the caller's OWN subscription and idempotent per delivery id: calling twice does not double-deliver, because each dead letter records that it has been replayed.

The replays re-enter the normal signing + retry path as NEW delivery attempts; the original dead-lettered rows stay terminal so the record of the failure survives the recovery. Send no body (or an empty `deliveryIds`) to replay everything eligible.

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RedriveWebhookDeliveriesRequest as application/*+json, application/json, text/json

Responses

200Success — RedriveWebhookDeliveriesResponse

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

POST/api/v1/webhooks/{id}/rotate-secret

Rotates the webhook's signing secret (FR-08.045). Generates a fresh secret and keeps the previous one valid for an overlap window (default 24h, max 7 days) so receivers can redeploy without dropping deliveries. The new secret is returned ONCE in the response and is never retrievable again.

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

Not marked as required in the document.

• RotateWebhookSecretRequest as application/*+json, application/json, text/json

Responses

200Success — RotateWebhookSecretResponse

400Bad Request — ProblemDetails

404Not Found — ProblemDetails

GET/api/v1/webhooks/{id}/statistics

Gets delivery statistics for a webhook subscription

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—
fromDate	query	string (date-time)	no	—
toDate	query	string (date-time)	no	—

Request body

No request body.

Responses

200Success — DeliveryStatisticsDto

404Not Found — ProblemDetails

POST/api/v1/webhooks/{id}/test

Sends a test webhook (for testing purposes)

Authentication:Bearer (the document-wide requirement)

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	yes	—

Request body

No request body.

Responses

202Accepted

404Not Found — ProblemDetails

Schemas

CreateWebhookSubscriptionRequest

Property	Type	Required	Description
description	string | null	no	—
eventTypes	string[] | null	no	—
secretKey	string | null	no	—
webhookUrl	string | null	no	—

CreateWebhookSubscriptionResponse

Property	Type	Required	Description
createdAt	string (date-time)	no	—
status	string | null	no	—
subscriptionId	string (uuid)	no	—

DeliveryStatisticsDto

Property	Type	Required	Description
averageDurationMs	number (double)	no	—
failedDeliveries	integer (int32)	no	—
pendingDeliveries	integer (int32)	no	—
successRate	number (double)	no	—
successfulDeliveries	integer (int32)	no	—
totalDeliveries	integer (int32)	no	—

ProblemDetails

Property	Type	Required	Description
detail	string | null	no	—
instance	string | null	no	—
status	integer (int32) | null	no	—
title	string | null	no	—
type	string | null	no	—

RedrivenDelivery

Property	Type	Required	Description
eventType	string | null	no	—
originalDeliveryId	string (uuid)	no	—
replacementDeliveryId	string (uuid)	no	—

RedriveWebhookDeliveriesRequest

Property	Type	Required	Description
deliveryIds	(string (uuid))[] | null	no	—
maxBatchSize	integer (int32) | null	no	—

RedriveWebhookDeliveriesResponse

Property	Type	Required	Description
moreAvailable	boolean	no	—
redriven	RedrivenDelivery[] | null	no	—
redrivenAt	string (date-time)	no	—
redrivenCount	integer (int32)	no	—
skipped	SkippedDelivery[] | null	no	—
subscriptionId	string (uuid)	no	—

RotateWebhookSecretRequest

Property	Type	Required	Description
overlapHours	integer (int32) | null	no	—

RotateWebhookSecretResponse

Property	Type	Required	Description
newSecret	string | null	no	—
previousSecretExpiresAt	string (date-time)	no	—
rotatedAt	string (date-time)	no	—
subscriptionId	string (uuid)	no	—

SkippedDelivery

Property	Type	Required	Description
deliveryId	string (uuid)	no	—
reason	string | null	no	—

TriggerWebhookEventRequest

Property	Type	Required	Description
eventType	string | null	no	—
payload	string | null	no	—
source	string | null	no	—

UpdateWebhookSubscriptionRequest

Property	Type	Required	Description
description	string | null	no	—
eventTypes	string[] | null	no	—
secretKey	string | null	no	—
webhookUrl	string | null	no	—

WebhookDeliveryLogDto

Property	Type	Required	Description
attemptNumber	integer (int32)	no	—
canRedrive	boolean	no	—
createdAt	string (date-time)	no	—
deliveredAt	string (date-time) | null	no	—
durationMs	integer (int64) | null	no	—
errorMessage	string | null	no	—
eventType	string | null	no	—
id	string (uuid)	no	—
nextRetryAt	string (date-time) | null	no	—
payload	string | null	no	—
redriveOfDeliveryId	string (uuid) | null	no	—
redrivenAt	string (date-time) | null	no	—
responseBody	string | null	no	—
status	string | null	no	—
statusCode	integer (int32) | null	no	—
subscriptionId	string (uuid)	no	—
updatedAt	string (date-time)	no	—
webhookUrl	string | null	no	—

WebhookSubscriptionDto

Property	Type	Required	Description
createdAt	string (date-time)	no	—
description	string | null	no	—
eventTypes	string[] | null	no	—
failureCount	integer (int32)	no	—
id	string (uuid)	no	—
lastFailureAt	string (date-time) | null	no	—
lastSuccessAt	string (date-time) | null	no	—
partnerId	string (uuid)	no	—
status	string | null	no	—
updatedAt	string (date-time)	no	—
webhookUrl	string | null	no	—

WebhookSubscriptionDtoPaginatedResponse

Property	Type	Required	Description
hasNextPage	boolean	no	—
hasPreviousPage	boolean	no	—
items	WebhookSubscriptionDto[] | null	no	—
pageNumber	integer (int32)	no	—
pageSize	integer (int32)	no	—
totalCount	integer (int32)	no	—
totalPages	integer (int32)	no	—