GET
/
webhooks
curl --request GET \
  --url https://app.getcensus.com/api/v1/webhooks \
  --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"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Response

200
application/json
Successfully retrieved the list of workspace webhooks.
​
status
enum<string>

The outcome of the fetch request

Available options:
success,
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