Skip to content

Retrieve a webhook endpoint

GET/v1/webhook-endpoints/{id}

Requires an API client bearer token.

Fetch a webhook endpoint by id (tenant-scoped; secret never included).

Parameters

Path parameters

NameRequiredDescription
idrequired

Example

curl https://api.rigid.fi/v1/webhook-endpoints/{id} \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

The webhook endpoint.

idstringrequired
urlstringrequired
event_typesarray of stringrequired
activebooleanrequired
created_atstringrequired
programme_idstring (uuid) | nullrequired
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Webhook endpoint not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring