Sign in
Webhooks

Get Webhook

CLI:

agentmail webhooks get --webhook-id <webhook_id>
get/v0/webhooks/{webhook_id}

Path parameters

webhook_idstring required

ID of webhook.

Response

webhook_idstring required

ID of webhook.

urlstring required

URL of webhook endpoint.

event_typesEventType[]

Event types for which to send events.

pod_idsstring[]

Pods for which to send events. Maximum 10 per webhook.

inbox_idsstring[]

Inboxes for which to send events. Maximum 10 per webhook.

secretstring required

Secret for webhook signature verification.

enabledboolean required

Webhook is enabled.

updated_atstring date-time required

Time at which webhook was last updated.

created_atstring date-time required

Time at which webhook was created.

client_idstring

Client ID of webhook.

Changes

Changed in 3 of the 34 revisions of this API.33

  • 394ddcdd9c293See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • ce126eb1243c1See the full diff
    • ●

      added the new message.received.unauthenticated enum value to the / response property for the response status

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 69e3767c5ada2See the full diff
    • ●

      added the new message.received.blocked enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new message.received.spam enum value to the / response property for the response status

      response-property-enum-value-added