Skip to content
Gave

Webhook endpoints

Where your events go, signed with a secret shown once. One endpoint for now.

List your webhook endpoints

GET/v1/webhook-endpoints

Your endpoints, without their secrets.

Responses

Register your webhook endpoint

POST/v1/webhook-endpoints

Registers the URL Gave sends your events to, and answers the secret that signs them, shown this once: keep it on your servers, and check every delivery's signature with it. One endpoint for now, at an https URL with a public host name. Gave never follows a redirect.

Request Body

application/json
idRequired
string
urlRequired
string·max 2048

Responses

Read a webhook endpoint

GET/v1/webhook-endpoints/{id}

The endpoint, without its secrets.

Path Parameters

idRequired
string

The endpoint's ID, which you chose.

Responses

Change a webhook endpoint's URL

PATCH/v1/webhook-endpoints/{id}

Deliveries go to the new URL within a minute. The secret doesn't change.

Path Parameters

idRequired
string

The endpoint's ID, which you chose.

Request Body

application/json
urlRequired
string·max 2048

Responses

Delete a webhook endpoint

DELETE/v1/webhook-endpoints/{id}

Stops deliveries within a minute. Events after that aren't sent: read balances and rewards through the API instead.

Path Parameters

idRequired
string

The endpoint's ID, which you chose.

Responses

Rotate a webhook endpoint's secret

POST/v1/webhook-endpoints/{id}/rotate-secret

Makes a new signing secret, shown this once, which signs deliveries within a minute. Each secret it replaces keeps signing for 24 hours from its rotation, up to four, so you can switch without missing a delivery, and a rotation retried after a lost answer cuts nothing off. Each call makes a new secret.

Path Parameters

idRequired
string

The endpoint's ID, which you chose.

Responses