Fetch webhook
Fetch a specific webhook by its ID
Request schema
Path parameters
webhook_id
integerrequired
ID of the webhook
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Http + 1.1
GET
https://app.getcensus.com/api/v1/webhooks/{webhook_id}
GET /api/v1/webhooks/{webhook_id} HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Host: app.getcensus.com
Responses
200
Successfully retrieved the webhook
401
Invalid credentials for the requested resource.
403
The feature you're trying to use is not available for your organization.
404
Resource not found.
200
status
string
The outcome of the fetch request
enum:
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.
name
stringrequired
The name of the webhook
example:
description
string
An optional description of the webhook
example:
events
array
The events that the webhook should alert on. By default all events are alerted on unless otherwise specified.
example:
type:
endpoint
stringrequired
The endpoint the webhook will ping when an event occurs in Census. Must be a secure (HTTPS) site.
example:
id
integer
The id of the webhook.
example:
401
status
integer
HTTP status code.
enum:
403
status
integer
HTTP status code.
enum:
message
string
Error message.
example:
404
status
integer
HTTP status code.
enum:
{ "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 } }