Webhooks

One subscription, secret included

Permission required: webhooks:read. The secret is readable, unlike an API key: it gives access to nothing on our side, and a service being redeployed needs it to verify signatures.

get/api/v1/webhooks/{id}

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/webhooks/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Response

The subscription.

object'webhook'
idstring
namestring

The name you give it.

urlstring uri
eventsstring[]
enabledboolean
secretstring

The signing secret (whsec_…). Returned on creation, when reading one specific subscription, and after a secret rotation — never in the list, which we log in full without a second thought.

created_atstring date-time
updated_atstring date-time

Changes

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