Skip to content
Docs

API Reference

Webhooks

Endpoints, deliveries, replay and secret rotation. Guide: Webhooks.

get/webhooks/endpointspost/webhooks/endpointsget/webhooks/endpoints/{id}patch/webhooks/endpoints/{id}delete/webhooks/endpoints/{id}post/webhooks/endpoints/{id}/rotate-secretpost/webhooks/endpoints/{id}/testget/webhooks/deliveriesget/webhooks/deliveries/{id}post/webhooks/deliveries/{id}/replay
get/webhooks/endpoints

List webhook endpoints

Scope webhooks:read

cURL
curl -X GET "https://serverless.grout.app/v1/webhooks/endpoints" \
  -H "Authorization: Bearer $GROUT_API_KEY"
post/webhooks/endpoints

Create an endpoint (secret returned once)

Scope webhooks:write

Body

  • urlhttps URL
  • descriptionstring
  • eventsstring[] ("*", "exam.*", exact)
cURL
curl -X POST "https://serverless.grout.app/v1/webhooks/endpoints" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"<url>","description":"<description>","events":[]}'
get/webhooks/endpoints/{id}

Get an endpoint

Scope webhooks:read

Parameters

  • idpath · stringrequired
cURL
curl -X GET "https://serverless.grout.app/v1/webhooks/endpoints/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
patch/webhooks/endpoints/{id}

Update / pause / resume an endpoint

Scope webhooks:write

Parameters

  • idpath · stringrequired
cURL
curl -X PATCH "https://serverless.grout.app/v1/webhooks/endpoints/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
delete/webhooks/endpoints/{id}

Delete an endpoint

Scope webhooks:write

Parameters

  • idpath · stringrequired
cURL
curl -X DELETE "https://serverless.grout.app/v1/webhooks/endpoints/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
post/webhooks/endpoints/{id}/rotate-secret

Rotate the signing secret (24h dual-secret grace)

Scope webhooks:write

Parameters

  • idpath · stringrequired

Body

  • grace_hoursinteger
cURL
curl -X POST "https://serverless.grout.app/v1/webhooks/endpoints/$ID/rotate-secret" \
  -H "Authorization: Bearer $GROUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"grace_hours":0}'
post/webhooks/endpoints/{id}/test

Send a synchronous ping

Scope webhooks:write

Parameters

  • idpath · stringrequired
cURL
curl -X POST "https://serverless.grout.app/v1/webhooks/endpoints/$ID/test" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/webhooks/deliveries

Delivery log

Scope webhooks:read

Parameters

  • endpoint_idquery · string
  • statusquery · string
  • event_typequery · string
  • pagequery · integer
  • limitquery · integer
cURL
curl -X GET "https://serverless.grout.app/v1/webhooks/deliveries" \
  -H "Authorization: Bearer $GROUT_API_KEY"
get/webhooks/deliveries/{id}

Delivery detail with payload and response

Scope webhooks:read

Parameters

  • idpath · stringrequired
cURL
curl -X GET "https://serverless.grout.app/v1/webhooks/deliveries/$ID" \
  -H "Authorization: Bearer $GROUT_API_KEY"
post/webhooks/deliveries/{id}/replay

Replay a delivery

Scope webhooks:write

Parameters

  • idpath · stringrequired
cURL
curl -X POST "https://serverless.grout.app/v1/webhooks/deliveries/$ID/replay" \
  -H "Authorization: Bearer $GROUT_API_KEY"