WebhookDto

One of the tenant's webhooks: an HTTPS URL that is sent the events it subscribes to, each signed with the
webhook's secret.

Properties

Name	Type	Description
code*	string	The webhook's code
The webhook's code
name*	string	What the webhook is for
What the webhook is for
url*	string	The HTTPS URL the events are sent to
The HTTPS URL the events are sent to
secret	string	The secret the deliveries are signed with (the X-Webhook-Signature header). Set when the webhook is created and on the single GET only, never in the list.
The secret the deliveries are signed with (the X-Webhook-Signature header). Set when the webhook is created and on the single GET only, never in the list.
enabled*	boolean	Whether events are sent. A webhook is switched off automatically after repeated failed deliveries.
Whether events are sent. A webhook is switched off automatically after repeated failed deliveries.
events*	array of enum	The events the webhook is sent TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled
The events the webhook is sent TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled
createdDate*	string	When the webhook was created
When the webhook was created
updatedDate	string	When the webhook was last changed
When the webhook was last changed

JSON Example

{
  "code": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "url": "string",
  "secret": "string",
  "enabled": false,
  "events": [
    "TestWebhook"
  ],
  "createdDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas

WebhookDtoPagedResult