Retrieve a webhook subscription

GET/v1/webhooks/{id}

Needs a bearer access token with the webhooks.read scope. How authentication works

One subscription, by id. The signing secret is never returned again.

curl -X GET "https://developer.rolefy.fit/api/v1/webhooks/3b1f7c52-8e4a-4d1b-9c0e-5a6d2f8b7e41" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200 · The subscription

{
  "data": {
    "id": "1d5f9b3a-7c2e-4e80-a6b4-3c8e0f2a5d71",
    "target_url": "https://example.com/webhooks/rolefy",
    "events": [
      "application.created",
      "job.status_changed"
    ],
    "status": "active",
    "created_at": "2026-03-14T09:30:00Z"
  }
}

Path parameters

idstring · uuidpathrequired
The subscription's id.

Responses

200The subscription
Response fields
- dataWebhook
  idstring · uuid
  target_urlstring
  eventsarray of string
  Allowed values:application.createdapplication.status_changedjob.status_changed
  statusstring
  Allowed values:activedisabled
  created_atstring · date-time

404Not found (not_found)

Example response

{
  "error": {
    "code": "not_found",
    "message": "Not found (`not_found`)."
  }
}