Webhook: invoice.ready

POST

Signed event notification. Verify the signature before applying business effects.

Parameters

Header parameters

webhook-id

required

string

Standard Webhooks message identifier. Equals the event id in the body and is the consumer’s idempotency key.

webhook-timestamp

required

string

/^[0-9]+$/

Unix seconds at which the delivery was signed. Reject a timestamp outside a five-minute tolerance.

webhook-signature

required

string

/^v1,[A-Za-z0-9+/=]+( v1,[A-Za-z0-9+/=]+)*$/

Space-separated list of v1, HMAC-SHA256 signatures over ... Accept the delivery when any entry matches.

Request body^required

Media typeapplication/json

discriminator: type

InvoiceAcceptedEvent

object

apiVersion

required

string

>= 1 characters

data

required

object

id

required

string format: uuid

integrationId

required

string format: uuid

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

id

required

string format: uuid

object

required

The wire family a delivered Webhook body announces.

string

Allowed values: event

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

sequence

required

string

/^[1-9][0-9]*$/

type

required

string

Allowed values: invoice.accepted

InvoiceRejectedEvent

object

apiVersion

required

string

>= 1 characters

data

required

object

id

required

string format: uuid

integrationId

required

string format: uuid

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

id

required

string format: uuid

object

required

The wire family a delivered Webhook body announces.

string

Allowed values: event

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

sequence

required

string

/^[1-9][0-9]*$/

type

required

string

Allowed values: invoice.rejected

InvoiceOperatorRequiredEvent

object

apiVersion

required

string

>= 1 characters

data

required

object

id

required

string format: uuid

integrationId

required

string format: uuid

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

id

required

string format: uuid

object

required

The wire family a delivered Webhook body announces.

string

Allowed values: event

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

sequence

required

string

/^[1-9][0-9]*$/

type

required

string

Allowed values: invoice.operatorRequired

InvoiceReadyEvent

object

apiVersion

required

string

>= 1 characters

data

required

object

id

required

string format: uuid

integrationId

required

string format: uuid

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

id

required

string format: uuid

object

required

The wire family a delivered Webhook body announces.

string

Allowed values: event

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

sequence

required

string

/^[1-9][0-9]*$/

type

required

string

Allowed values: invoice.ready

InvoiceDeliverySentEvent

object

apiVersion

required

string

>= 1 characters

data

required

The Invoice and the buyer email whose sent or failed outcome the event announces.

object

deliveryId

required

string format: uuid

id

required

string format: uuid

integrationId

required

string format: uuid

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

id

required

string format: uuid

object

required

The wire family a delivered Webhook body announces.

string

Allowed values: event

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

sequence

required

string

/^[1-9][0-9]*$/

type

required

string

Allowed values: invoice.deliverySent

InvoiceDeliveryFailedEvent

object

apiVersion

required

string

>= 1 characters

data

required

The Invoice and the buyer email whose sent or failed outcome the event announces.

object

deliveryId

required

string format: uuid

id

required

string format: uuid

integrationId

required

string format: uuid

environment

required

DGII execution environment selected before lifecycle admission.

string

Allowed values: sandbox certification production

id

required

string format: uuid

object

required

The wire family a delivered Webhook body announces.

string

Allowed values: event

occurredAt

required

string format: date-time

organizationId

required

string format: uuid

sequence

required

string

/^[1-9][0-9]*$/

type

required

string

Allowed values: invoice.deliveryFailed

Responses

2XX

2XX

The event was accepted.