API Docs / Schemas / CreateWebhookRequest

CreateWebhookRequest

A webhook to create. Its secret is generated.

Properties

Name Type Description
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

enabled*boolean

Whether events are sent

Whether events are sent

events*array of enum

The events the webhook is sent; at least one

TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled

The events the webhook is sent; at least one

TestWebhook SubcontractorCreated SubcontractorUpdated SubcontractorDeleted SubcontractorVerified SubcontractorVerificationFailed SubcontractorVerificationRemoved InvoiceCreated InvoiceUpdated InvoiceDeleted ReturnOpened ReturnSubmitted ReturnAccepted ReturnFailed WebhookAutoDisabled

JSON Example

{
  "name": "string",
  "url": "string",
  "enabled": false,
  "events": [
    "TestWebhook"
  ]
}

Used By Operations