v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB

Webhooks

Create Webhook

Create a Webhook.

post/print-mail/v1/webhooks

urlstring uri required

An HTTPS URL that PostGrid can invoke for webhook deliveries.

enabledEventsWebhookEventType[] required

The list of event types this webhook listens for.

payloadFormat'jwt' | 'json'

The format in which a Webhook's event payload is delivered.

secretstring

A webhook signing secret with at least 20 non-whitespace characters.

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

The newly created Webhook.

idstring required

A unique ID prefixed with webhook_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.