Skip to main content
GET
List webhook endpoints

Authorizations

Authorization
string
header
required

Paubox API uses Bearer token authentication in the Authorization header.

Format: Authorization: Bearer YOUR_API_KEY_HERE

Example: Authorization: Bearer 9e5b092b632445b8f570c62ae54f30fda1044305

The legacy format Authorization: Token token=YOUR_API_KEY_HERE is also supported.

Query Parameters

page
integer
default:1

Page number.

items
integer
default:25

Endpoints per page (1-100).

Required range: x <= 100

Only return endpoints whose target URL contains this text. Applies to paginated requests.

order_by
enum<string>

Sort field for paginated requests. Defaults to creation time.

Available options:
id,
target_url,
updated_at
order
enum<string>
default:desc

Sort direction for paginated requests.

Available options:
asc,
desc

Response

200 - application/json

List of webhook endpoints

id
integer
Example:

42

api_customer_id
integer
Example:

1001

target_url
string
Example:

"https://example.com/webhooks/paubox"

events
enum<string>[]
Available options:
api_mail_log_delivered,
api_mail_log_opened,
api_mail_log_temporary_failure,
api_mail_log_permanent_failure
Example:
active
boolean
Example:

true

created_at
string<date-time>
updated_at
string<date-time>