Skip to main content

WebhookCallResponseDto

DTO representing a webhook call attempt and its details.

companyNamestringnullable

The name of the company.

tenantIdstringrequired

The unique identifier of the tenant.

correlationIdstring<uuid>required

The correlation ID associated with the webhook call.

webhookIdstring<uuid>required

The unique identifier of the webhook.

webhookRequestIdstring<uuid>required

The unique identifier of the webhook request.

webhookUrlstringrequired

The URL of the webhook.

eventTypestringrequired

The type of event that triggered the webhook.

calledAtstring<date-time>required

The timestamp when the webhook was called.

attemptNumberinteger<int32>

The attempt number of the webhook call.

responseTimeMillisecondsinteger<int32>

The response time of the webhook call in milliseconds.

httpResponseStatusCodeinteger<int32>nullable

The HTTP response status code returned by the webhook.

errorMessagestringnullable

The error message returned by the webhook, if any.

isSuccessboolean

Indicates whether the webhook call was successful.

WebhookCallResponseDto
{
"companyName": "string",
"tenantId": "string",
"correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"webhookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"webhookRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"webhookUrl": "string",
"eventType": "string",
"calledAt": "2024-07-29T15:51:28.071Z",
"attemptNumber": 0,
"responseTimeMilliseconds": 0,
"httpResponseStatusCode": 0,
"errorMessage": "string",
"isSuccess": true
}