Go SDK webhook client

Webhook endpoint methods require SDK 2.0.0 or later. They are on *paubox.WebhooksClient, not on the *paubox.Client you use to send email.

*paubox.WebhooksClient 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

import "github.com/paubox/paubox-go/v2"

webhooks, err := paubox.NewWebhooks("YOUR_API_KEY")
if err != nil {
    log.Fatal(err)
}

NewWebhooks returns an error if the key is empty. It accepts WithWebhooksBaseURL, WithWebhooksHTTPClient, WithWebhooksTimeout, WithWebhooksRetry, and WithWebhooksUserAgent options. The client is safe for concurrent use.

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

list, err := webhooks.ListWebhookEndpoints(ctx, &paubox.ListWebhookEndpointsParams{
    Page:  paubox.Ptr(1),
    Items: paubox.Ptr(50),
})
if err != nil {
    return err
}
for _, ep := range list.Data {
    fmt.Println(ep.ID, ep.TargetURL, ep.Status)
}
fmt.Println(list.PageInfo.Count)

Pass nil for the default page. PageInfo.Count is the total number of endpoints, not the length of Data. Endpoints carrying an event the key isn’t scoped for are left out.

Create a webhook endpoint

created, err := webhooks.CreateWebhookEndpoint(ctx, &paubox.CreateWebhookEndpointRequest{
    TargetURL: "https://example.com/webhooks/paubox",
    Events:    []string{"api_mail_log_delivered", "api_mail_log_opened"},
})
if err != nil {
    return err
}
fmt.Println(created.ID)
fmt.Println(created.SigningSecret)

TargetURL must be an https URL that doesn’t point at a private or internal address. CreateWebhookEndpoint returns a *paubox.CreatedWebhookEndpoint, which embeds paubox.WebhookEndpoint (ID, TargetURL, Status, Events, CreatedAt, UpdatedAt) and adds SigningSecret. The 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, err := webhooks.GetWebhookEndpoint(ctx, "2ec66c21-bf48-48eb-8d28-f80b2d6b77c7")

Update a webhook endpoint

endpoint, err := webhooks.UpdateWebhookEndpoint(ctx, "2ec66c21-bf48-48eb-8d28-f80b2d6b77c7",
    &paubox.UpdateWebhookEndpointRequest{
        Status: paubox.Ptr("disabled"),
    })

UpdateWebhookEndpointRequest has optional TargetURL, Status ("active" or "disabled"), and Events fields. Only the fields you set are sent. Events replaces the endpoint’s event list.

Delete a webhook endpoint

err := webhooks.DeleteWebhookEndpoint(ctx, "2ec66c21-bf48-48eb-8d28-f80b2d6b77c7")

Error handling

var apiErr *paubox.PauboxError
if errors.As(err, &apiErr) {
    fmt.Println(apiErr.StatusCode, apiErr.Title)
}

A non-2xx response returns a *paubox.PauboxError, the same type the email and forms clients return, with the API’s error text in Title. Creating a second endpoint for the same TargetURL returns 422, and an ID that isn’t on your account returns 404. An ID that isn’t a UUID returns an error 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