Create 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.
/v2/webhooks/{teamId}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.
Authorization
apiKey Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.
In: header
Path Parameters
uuidRequest Body
application/json
On create, the dispatcher asynchronously runs a verification handshake: it sends a GET to url with micro_hook_mode=subscribe, a one-time micro_hook_challenge, and the webhook's micro_hook_token. The endpoint must respond 200 and echo the challenge value verbatim in the body; on success the webhook's verified flag flips to true. A failed handshake does not fail creation — re-run it later via the verify endpoint.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://developers.micro.so/v2/webhooks/${MICRO_TEAM_ID}" \ -H "x-api-key: $MICRO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "url": "http://example.com" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "url": "http://example.com", "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba", "enabled": true, "verified": true, "verified_at": "2019-08-24T14:15:22Z", "verification_token": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "secret": "string", "verification": { "status": "pending" }}