Skip to navigation
API ReferenceWebhooks

Update Webhook

Update inbox or pod subscriptions, or replace the webhook’s event_types in full when you pass a non-empty event_types array (see request field docs). Inbox and pod changes use add/remove lists.

CLI:

postnuvia webhooks update --webhook-id <webhook_id> --add-inbox-ids <inbox_id>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

webhook_idstringRequired
ID of webhook.

Request

This endpoint expects an object.
add_inbox_idslist of stringsOptional

Inbox IDs to subscribe to the webhook. This only adds to what the webhook receives: on a webhook that covers its whole pod, it changes nothing. To receive only specific inboxes, create a webhook with inbox_ids instead.

add_pod_idslist of stringsOptional
Pod IDs to subscribe to the webhook.
enabledbooleanOptional

Set to true to re-enable a webhook that was disabled after repeated failed deliveries, or false to disable it. Events that occurred while the webhook was disabled are not redelivered. Re-enabling a webhook subscribed to message.received.spam, message.received.blocked, or message.received.unauthenticated (or to every event type, with no filter) requires the matching label permissions on the API key.

event_typeslist of enumsOptional

When you send a non-empty list, it replaces the webhook's subscribed event types in full (the same "set the list" behavior as create). It is not a merge or diff: include every event type you want after the update. Sending a one-element array means the webhook will only receive that one type afterward. Omit this field or send an empty array to leave event types unchanged. Clearing all types with an empty list is not supported. Subscribing to message.received.spam, message.received.blocked, or message.received.unauthenticated requires the matching label permission on the API key.

remove_inbox_idslist of stringsOptional
Inbox IDs to unsubscribe from the webhook.
remove_pod_idslist of stringsOptional
Pod IDs to unsubscribe from the webhook.

Response

This endpoint returns an object.
webhook_idstring
ID of webhook.
urlstring
URL of webhook endpoint.
secretstring
Secret for webhook signature verification.
enabledboolean
Webhook is enabled.
updated_atdatetime
Time at which webhook was last updated.
created_atdatetime
Time at which webhook was created.
event_typeslist of enumsOptional
Event types for which to send events.
pod_idslist of stringsOptional
Pods for which to send events. Maximum 10 per webhook.
inbox_idslist of stringsOptional
Inboxes for which to send events. Maximum 10 per webhook.
pod_idstringOptional

ID of the pod the webhook belongs to: the pod it was created in, or the pod of the inbox it belongs to. Absent for an organization webhook and on some inbox webhooks. This is not the list of pods it receives events for; see pod_ids.

inbox_idstringOptional

ID of the inbox the webhook belongs to, if it was created for an inbox. This is not the list of inboxes it receives events for; see inbox_ids.

client_idstringOptional
Client ID of webhook.

Errors

400
Validation Error
404
Not Found Error