POST
/
webhooks
curl --request POST \
  --url https://app.getcensus.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Webhook",
  "description": "Webhook for failed syncs ",
  "events": [
    "sync.alert.raised",
    "sync.alert.resolved"
  ],
  "endpoint": "https://mycompany.com/census-sync-alerts"
}'
{
  "status": "created",
  "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,
    "secret": "my123secret"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

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

​
name
string
required

The name of the webhook

Example:

"My Webhook"

​
endpoint
string
required

The endpoint the webhook will ping when an event occurs in Census. Must be a secure (HTTPS) site.

Example:

"https://mycompany.com/census-sync-alerts"

​
description
string

An optional description of the webhook

Example:

"Webhook for failed syncs "

​
events
enum<string>[]

The events that the webhook should alert on. By default all events are alerted on unless otherwise specified.

Available options:
sync.alert.raised,
sync.alert.resolved,
sync.triggered,
sync.started,
sync.completed,
sync.success,
sync.failed
Example:
["sync.alert.raised", "sync.alert.resolved"]

Response

201
application/json
Successfully created webhook.
​
status
enum<string>

The outcome of the create request

Available options:
created,
error
Example:

"created"

​
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