Skip to content

AdminWebhook

A webhook endpoint. Its secret is never shown again after it is made.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
url
required

Where the messages are posted.

string
description

What the webhook is for; omitted for none.

string
events
required

The events it subscribes to, in a stable order.

Array<string>
Allowed values: report.created report.resolved report.reopened registration.pending account.created account.updated moderation_action.created moderation_action.lifted appeal.created domain_moderation_action.created domain_moderation_action.lifted status.created custom_emoji.created custom_emoji.updated custom_emoji.deleted error_group.created error_group.regressed
state
required

Whether the webhook receives the messages of its events.

string
Allowed values: enabled disabled
state_reason
required

Who set state last. admin: a staff member, or the my command line. gone: the server disabled it after the endpoint answered 410 Gone. failing: the server disabled it after the deliveries kept failing, without a success, for 72 hours and 20 attempts.

string
Allowed values: admin gone failing
state_changed_at
required
string format: date-time
failure
object
created_at
required
string format: date-time
revised_at
required

When the URL, the description, or the events last changed.

string format: date-time

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"url": "example",
"description": "example",
"events": [
"report.created"
],
"state": "enabled",
"state_reason": "admin",
"state_changed_at": "2026-04-15T12:00:00Z",
"failure": {},
"created_at": "2026-04-15T12:00:00Z",
"revised_at": "2026-04-15T12:00:00Z"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site