Skip to main content

Authorizations

Authorization
string
header
required

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

Headers

webhook-version
enum<string>
required

Payload envelope version. Always v2 for events documented here.

Available options:
v2
webhook-event-id
string
required

Stable event ID (matches id in the body). Use to dedupe retries.

modapi-signature
string

HMAC-SHA256 signature of the raw request body, signed with the webhook secret. Verify before trusting the payload.

Body

application/json
id
string
required

Stable event ID. Use this to dedupe retries.

Example:

"evt_clxxx..."

type
string
required

The event type.

Allowed value: "author.suspended"
Example:

"author.suspended"

api_version
string
required
Allowed value: "v2"
Example:

"v2"

created
string<date-time>
required

ISO 8601 timestamp of when the event was emitted.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
data
object
required

Response

200

Acknowledge receipt. Any 2xx status closes the delivery as successful; non-2xx triggers retry with exponential backoff.