Python SDK webhook client

Webhook endpoint methods require SDK 2.0.0 or later. They are on PauboxWebhooksClient, not on the PauboxApiClient you use to send email.

PauboxWebhooksClient manages webhook endpoints through the Paubox webhooks service at https://api.paubox.com/v1/webhooks. It sends a scoped API key as Authorization: Bearer YOUR_API_KEY. The key’s scopes decide which events it can subscribe to.

Create the client

from paubox import PauboxWebhooksClient

webhooks = PauboxWebhooksClient(api_key="YOUR_API_KEY")

The client doesn’t read an environment variable; pass api_key explicitly, as a keyword argument. The first positional argument is base_url, so PauboxWebhooksClient("YOUR_API_KEY") treats the key as the base URL. Pass base_url to override the base URL. Every method raises ValueError before sending a request if no key is set.

Events

Event	Required scope	Fires when
`api_mail_log_delivered`	`email_api`	An Email API message is delivered
`api_mail_log_opened`	`email_api`	A delivered message is opened
`api_mail_log_temporary_failure`	`email_api`	Delivery fails temporarily
`api_mail_log_permanent_failure`	`email_api`	Delivery fails permanently
`email.inbound.received`	`email_api`, with no sender-domain limit	Inbound mail is received
`forms.submission.created`	`forms`	A form submission is received

The SDK doesn’t check event names. The API returns 422 for an unknown event and 403 for an event the key isn’t scoped for. Email API keys created in the Paubox Dashboard are limited to a sender domain, so subscribe to inbound mail in the Paubox Dashboard under Settings > Webhooks. For payloads and signature verification, see Webhooks.

List webhook endpoints

response = webhooks.list_webhook_endpoints(page=1, items=50)
body = response.to_dict

for endpoint in body["data"]:
    print(endpoint["id"], endpoint["target_url"], endpoint["status"])
print(body["page_info"]["count"])

Every method returns a Response; read the parsed JSON from to_dict. page and items are optional. page_info["count"] is the total number of endpoints, not the length of this page. Endpoints carrying an event the key isn’t scoped for are left out.

Create a webhook endpoint

response = webhooks.create_webhook_endpoint(
    target_url="https://example.com/webhooks/paubox",
    events=["api_mail_log_delivered", "api_mail_log_opened"],
)
endpoint = response.to_dict["data"]

print(endpoint["id"])
print(endpoint["signing_secret"])

target_url must be an https URL that doesn’t point at a private or internal address. Each endpoint has id (a UUID), target_url, status (active or disabled), events, created_at, and updated_at. signing_secret is returned only by this call; store it when you create the endpoint. To replace a lost secret, delete the endpoint and create a new one.

Get a webhook endpoint

endpoint = webhooks.get_webhook_endpoint("2ec66c21-bf48-48eb-8d28-f80b2d6b77c7").to_dict["data"]

Update a webhook endpoint

endpoint = webhooks.update_webhook_endpoint(
    "2ec66c21-bf48-48eb-8d28-f80b2d6b77c7",
    status="disabled",
).to_dict["data"]

Pass any of target_url, status ("active" or "disabled"), and events. Only the arguments you pass are sent. events replaces the endpoint’s event list.

Delete a webhook endpoint

response = webhooks.delete_webhook_endpoint("2ec66c21-bf48-48eb-8d28-f80b2d6b77c7")
print(response.status_code)

The API responds with 204 No Content, so to_dict is None.

Error handling

import requests

try:
    webhooks.create_webhook_endpoint(
        target_url="https://example.com/webhooks/paubox",
        events=["api_mail_log_delivered"],
    )
except requests.exceptions.HTTPError as err:
    print(err.response.status_code, err)

A non-2xx response raises requests.exceptions.HTTPError whose message is the API’s error text. Creating a second endpoint for the same target_url returns 422, and an ID that isn’t on your account returns 404. An ID that isn’t a UUID raises ValueError before any request is sent.

Get started

Email API

Migrate to Paubox

Marketing API

MCP Server

SDKs

CLI

Forms API

Create the client

Events

List webhook endpoints

Create a webhook endpoint

Get a webhook endpoint

Update a webhook endpoint

Delete a webhook endpoint

Error handling

​Create the client

​Events

​List webhook endpoints

​Create a webhook endpoint

​Get a webhook endpoint

​Update a webhook endpoint

​Delete a webhook endpoint

​Error handling

Create the client

Events

List webhook endpoints

Create a webhook endpoint

Get a webhook endpoint

Update a webhook endpoint

Delete a webhook endpoint

Error handling