Webhooks

Update Webhook

Update a Webhook by ID.

post/print-mail/v1/webhooks/{id}

Path parameters

idstring required

The ID of the Webhook to update.

descriptionstring

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

metadataobject

See the section on Metadata.

urlstring uri

An HTTPS URL that PostGrid can invoke for webhook deliveries.

enabledEventsWebhookEventType[]

The list of event types this webhook listens for.

payloadFormat'jwt' | 'json'

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

enabledboolean

Whether this webhook is enabled. Disabled webhooks are not triggered.

secretstring

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

The updated 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.

Changed in 1 of the 7 revisions of this API.1