PHP SDK webhook client

The methods on this page require SDK 2.0.0 or later, where Paubox\PauboxWebhooks uses the Paubox webhooks service and a scoped API key.

Paubox\PauboxWebhooks 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

use Paubox\PauboxWebhooks;

$webhooks = new PauboxWebhooks('YOUR_API_KEY');

When the key is omitted, the client reads the PAUBOX_WEBHOOKS_API_KEY environment variable. Pass a base URL as the second argument or set PAUBOX_WEBHOOKS_BASE_URL to override it. Every method throws Paubox\Webhooks\PauboxWebhooksException 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

$result = $webhooks->listWebhookEndpoints(['page' => 1, 'items' => 50]);

foreach ($result->data as $endpoint) {
    echo $endpoint->id . ' ' . $endpoint->target_url . ' ' . $endpoint->status . "\n";
}
echo $result->page_info->count . "\n";

The argument is optional. Responses are decoded into objects. 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

$endpoint = $webhooks->createWebhookEndpoint([
    'target_url' => 'https://example.com/webhooks/paubox',
    'events' => ['api_mail_log_delivered', 'api_mail_log_opened'],
]);

echo $endpoint->id . "\n";
echo $endpoint->signing_secret . "\n";

target_url must be an https URL that doesn’t point at a private or internal address. The array is sent to the API as given, so pass only target_url and events. 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->getWebhookEndpoint('2ec66c21-bf48-48eb-8d28-f80b2d6b77c7');

Update a webhook endpoint

$endpoint = $webhooks->updateWebhookEndpoint('2ec66c21-bf48-48eb-8d28-f80b2d6b77c7', [
    'status' => 'disabled',
]);

Pass any of target_url, status (active or disabled), and events. events replaces the endpoint’s event list.

Delete a webhook endpoint

$webhooks->deleteWebhookEndpoint('2ec66c21-bf48-48eb-8d28-f80b2d6b77c7');

Returns true.

Error handling

use Paubox\Webhooks\PauboxWebhooksException;

try {
    $webhooks->createWebhookEndpoint([
        'target_url' => 'https://example.com/webhooks/paubox',
        'events' => ['api_mail_log_delivered'],
    ]);
} catch (PauboxWebhooksException $e) {
    echo $e->getStatusCode() . ' ' . $e->getMessage() . "\n";
}

Webhook methods throw Paubox\Webhooks\PauboxWebhooksException on a non-2xx response. It provides getStatusCode(), getUrl(), and getResponseBody(), and its message includes 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 throws 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