Create Webhook

print_mail.webhooks.create() -> Webhook

POST/print-mail/v1/webhooks

Create a Webhook.

ParametersExpand Collapse

enabled_events: List[Literal["letter.created", "letter.updated", "postcard.created", 18 more]]

The list of event types this webhook listens for.

One of the following:

"letter.created"

"letter.updated"

"postcard.created"

"postcard.updated"

"self_mailer.created"

"self_mailer.updated"

"cheque.created"

"cheque.updated"

"box.created"

"box.updated"

"snap_pack.created"

"snap_pack.updated"

"return_envelope_order.created"

"return_envelope_order.updated"

"tracker.visited"

"campaign.created"

"campaign.updated"

"virtual_mailbox_item.created"

"postal_statement.created"

"document.created"

"document.updated"

url: str

An HTTPS URL that PostGrid can invoke for webhook deliveries.

formaturi

description: Optional[str]

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

metadata: Optional[Dict[str, object]]

See the section on Metadata.

payload_format: Optional[Literal["jwt", "json"]]

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

One of the following:

"jwt"

"json"

secret: Optional[str]

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

minLength20

ReturnsExpand Collapse

class Webhook: …

id: str

A unique ID prefixed with webhook_

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

enabled: bool

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

enabled_events: List[Literal["letter.created", "letter.updated", "postcard.created", 18 more]]

The list of event types this webhook listens for.

One of the following:

"letter.created"

"letter.updated"

"postcard.created"

"postcard.updated"

"self_mailer.created"

"self_mailer.updated"

"cheque.created"

"cheque.updated"

"box.created"

"box.updated"

"snap_pack.created"

"snap_pack.updated"

"return_envelope_order.created"

"return_envelope_order.updated"

"tracker.visited"

"campaign.created"

"campaign.updated"

"virtual_mailbox_item.created"

"postal_statement.created"

"document.created"

"document.updated"

live: bool

true if this is a live mode resource else false.

object: Literal["webhook"]

Always webhook.

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

url: str

An HTTPS URL that PostGrid can invoke for webhook deliveries.

formaturi

description: Optional[str]

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

metadata: Optional[Dict[str, object]]

See the section on Metadata.

payload_format: Optional[Literal["jwt", "json"]]

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

One of the following:

"jwt"

"json"

secret: Optional[str]

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

minLength20

Create Webhook

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
webhook = client.print_mail.webhooks.create(
    enabled_events=["letter.created"],
    url="https://example.com/postgrid-webhook",
    description="Letter Created",
)
print(webhook.id)

{
  "id": "webhook_skN2ZTvFwS62oc5tJY1gzw",
  "object": "webhook",
  "live": false,
  "description": "Letter Created",
  "url": "https://example.com/postgrid-webhook",
  "enabledEvents": [
    "letter.created"
  ],
  "payloadFormat": "jwt",
  "enabled": true,
  "secret": "webhook_secret_xkNXtQ4jHevFdkTG3mSf1Q",
  "createdAt": "2022-02-16T18:37:02.048Z",
  "updatedAt": "2022-02-16T18:37:02.048Z"
}

Returns Examples

{
  "id": "webhook_skN2ZTvFwS62oc5tJY1gzw",
  "object": "webhook",
  "live": false,
  "description": "Letter Created",
  "url": "https://example.com/postgrid-webhook",
  "enabledEvents": [
    "letter.created"
  ],
  "payloadFormat": "jwt",
  "enabled": true,
  "secret": "webhook_secret_xkNXtQ4jHevFdkTG3mSf1Q",
  "createdAt": "2022-02-16T18:37:02.048Z",
  "updatedAt": "2022-02-16T18:37:02.048Z"
}