Webhooks

Create a subscription

Permission required: webhooks:write. The response carries the secret — store it like a password, it is what verifies every call.

post/api/v1/webhooks

Request

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

Request body

namestring required
urlstring uri required

https required, and never a private-network address.

eventsstring[] required

Example request

{
  "name": "My CRM",
  "url": "https://your-service.com/mailcheer/events"
}

Response

Created.

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.