Webhooks

Subscribe an endpoint to platform events and verify signed deliveries.

Outgoing webhooks push platform events to an endpoint you control, so external systems can react to what happens on Gheima. They are managed through the API.

Create a webhook#

POST a URL and (optionally) the events you want. Leave events empty, or include “*”, to receive all of them. The signing secret is returned once — store it safely.

Shell

curl -X POST https://gheima.ma/api/v1/webhooks \
  -H "Authorization: Bearer gh_xxxxx" -H "content-type: application/json" \
  -d '{"url":"https://example.com/hook","events":["deployment.created"]}'

Events#

deployment.created — a deployment started.
service.created / service.deleted — a service was created or removed.
database.created — a database was provisioned.
ping — the test event.

Verify deliveries#

Each delivery is a JSON body { event, data, timestamp } with an x-gheima-event header and an x-gheima-signature header (sha256=HMAC of the raw body using your secret). Verify the signature before trusting the payload. Send a sample delivery any time:

Shell

curl -X POST https://gheima.ma/api/v1/webhooks/<id>/test \
  -H "Authorization: Bearer gh_xxxxx"

Sends a ping event to your endpoint.

✦ Your systems react to Gheima events in real time, with signed payloads you can verify.