GET
/
webhooks
/
{webhook_id}
curl --request GET \
  --url https://app.getcensus.com/api/v1/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "data": {
    "name": "My Webhook",
    "description": "Webhook for failed syncs ",
    "events": [
      "sync.alert.raised",
      "sync.alert.resolved"
    ],
    "endpoint": "https://mycompany.com/census-sync-alerts",
    "id": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

​
webhook_id
integer
required

ID of the webhook

Response

200
application/json
Successfully retrieved the webhook
​
status
enum<string>

The outcome of the fetch request

Available options:
success,
not_found,
error
Example:

"success"

​
data
object

Webhooks are used to notify you when sync alerts are raised or resolved, or when certain lifecycle events happen during a sync run.

Was this page helpful?

Raise issue