Webhooks

Update a webhook endpoint

Update a webhook endpoint's target URL or subscribed events, or disable it by setting active to false. Only the fields you send are changed.

patch/webhook_endpoints/{id}

Request

  • Base URL: https://api.paubox.com/v1/email
  • URL: https://api.paubox.com/v1/email/webhook_endpoints/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Webhook endpoint ID

Request body

target_urlstring

New HTTPS URL.

eventsstring[]
activeboolean
api_keystring

Response

Webhook endpoint updated

messagestring

Example response

{
  "message": "Webhook updated!",
  "data": {
    "id": 42,
    "target_url": "https://example.com/webhooks/paubox",
    "events": [
      "inbound_mail_received",
      "api_mail_log_delivered"
    ],
    "active": true,
    "signing_key": "whsec_abc123"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.