Register a webhook

Register a URL to receive webhook notifications for grant and token events. Valid events: grant.created, grant.revoked, token.issued. Webhook payloads are signed with the returned secret (HMAC-SHA256).

POST /v1/webhooks

Register a webhook

cURL

curl --request POST \
  --url https://grantex-auth-dd4mtrt2gq-uc.a.run.app/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "grant.created"
  ]
}
'

201

{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "grant.created"
  ],
  "secret": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Developer API key

Body

application/json

url · string<uri> · required

events · enum<string>[] · required

Minimum array length: 1

Available options: grant.created, grant.revoked, token.issued

Response

201

application/json

Webhook registered

id · string

url · string<uri>

events · enum<string>[]

Available options: grant.created, grant.revoked, token.issued

secret · string

Only returned on creation

createdAt · string<date-time>