Skip to content

ban.created

POST

A user or IP range was banned.

webhook-id
required
string

Unique id of this delivery. Deduplicate on it.

webhook-timestamp
required
string

Unix time in seconds when the delivery was signed.

webhook-signature
required
string

Standard Webhooks signature, v1,<base64 HMAC-SHA256> of id.timestamp.body.

Media typeapplication/json
BanCreatedWebhook

A user or IP range was banned.

object
data
required
BanData

The event payload, with external ids.

object
ban_id
required
Ban Id

Id of the ban.

string format: uuid
cidr
Any of:
string
expires_at
required
Any of:
string format: date-time
external_id
Any of:
string
timestamp
required
Timestamp

When the event was emitted.

string format: date-time
type
required
Type

Always ban.created.

string
default: ban.created
Allowed value: ban.created

Any 2xx acknowledges it