v25

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0131545750.2 KB

Create a webhook

Registers a webhook and enqueues an asynchronous verification handshake (run by the dispatcher). The response includes the signing secret, shown only this once; verified is false until the handshake passes.

post/v2/webhooks/{teamId}

Path parameters

teamIdstring uuid required

Request body

namestring required

urlstring uri required

HTTP(S) endpoint. Rejected if it resolves to a private/internal address.

descriptionstring nullable

enabledboolean

Response

The created webhook, including its one-time signing secret.

idstring uuid required

namestring required

descriptionstring nullable

urlstring uri required

Endpoint events are delivered to.

team_idstring uuid required

enabledboolean required

Disabled webhooks are skipped at delivery time.

verifiedboolean required

True once the endpoint has completed the verification handshake.

verified_atstring date-time nullable

verification_tokenstring

Stable token replayed to the endpoint (as the micro_hook_token query param) during the verification handshake. The endpoint may check it to confirm the request originated from Micro.

created_atstring date-time required

updated_atstring date-time nullable

secretstring required

HMAC signing secret (prefix whsec_). Store it now — it is never returned again. The dispatcher signs each delivered payload with it so your endpoint can verify authenticity.