Skip to navigation
API ReferenceWebhooksPolling

Get Polling Webhook

The token is never returned here: create again with the same client_id to get a new one.

CLI:

agentmail webhooks polling get --webhook-id <webhook_id>

Authentication

AuthorizationBearer

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

Path parameters

webhook_idstringRequired
ID of webhook.

Response

This endpoint returns an object.
webhook_idstring
ID of webhook.
client_idstring

Required. Idempotency key of the subscription: creating again with the same client_id through the same route returns the existing subscription with a fresh token instead of a second subscription, so a restarted agent resumes where it left off. Also accepted in place of webhook_id on get and delete.

event_typeslist of enums
Event types for which to send events.
updated_atdatetime
Time at which the subscription was last updated.
created_atdatetime
Time at which the subscription was created.
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 subscription belongs to: the pod it was created in, or the pod of the inbox it belongs to. Absent for an organization subscription. This is not the list of pods it receives events for; see pod_ids.

inbox_idstringOptional

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

Errors

404
Not Found Error