Update a webhook

Changed on

Updates mutable fields. Changing url resets verification and re-runs the handshake.

patch/v2/webhooks/{teamId}/{webhookId}

Request

  • Base URL
    https://developers.micro.so
  • URL
    https://developers.micro.so/v2/webhooks/{teamId}/{webhookId}
  • Auth
    API key in header x-api-key

Path parameters

teamIdstring uuid required
webhookIdstring uuid required

Request body

namestring
descriptionstring nullable
urlstring uri
enabledboolean

Response

The updated webhook.

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

Changes