Webhooks

Retrieve a webhook endpoint

Requires scope: read.

get/v1/webhooks/{id}

Request

  • Base URL: https://api.mails.ai
  • URL: https://api.mails.ai/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Webhook endpoint id (whe_…).

Response

The endpoint. The signing secret is never returned here.

idstring required

Webhook endpoint id (whe_…).

urlstring uri required

The URL events are POSTed to.

event_typesstring[] required

The event types this endpoint receives. * is every type except thread.created, thread.updated, thread.deleted and message.delayed, which reach an endpoint only when it lists them by name.

descriptionstring nullable

Your note about the endpoint, or null when it has none.

activeboolean required

false while the endpoint is paused: nothing is delivered to it until PATCH /v1/webhooks/{id} sets it back to true.

secret_rotated_atstring date-time nullable

When the signing secret was last rotated.

previous_secret_expires_atstring date-time nullable

While set, deliveries are signed with both the new and the previous secret; null once the previous one stops signing.

created_atstring required

When the endpoint was created (ISO 8601, UTC).

Changes

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