Create a webhook

Create a new webhook in the workspace.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

name

stringrequired

The name of the webhook

example:

My Webhook

description

string

An optional description of the webhook

example:

Webhook for failed syncs

events

array

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

example:

[ "sync.alert.raised", "sync.alert.resolved" ]

type:

string

endpoint

stringrequired

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

Http + 1.1

POST

https://app.getcensus.com/api/v1/webhooks

POST /api/v1/webhooks HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 200

{
  "name": "My Webhook",
  "description": "Webhook for failed syncs ",
  "events": [
    "sync.alert.raised",
    "sync.alert.resolved"
  ],
  "endpoint": "https://mycompany.com/census-sync-alerts"
}

Responses

201

Successfully created webhook.

400

Bad Request

401

Invalid credentials for the requested resource.

403

The feature you're trying to use is not available for your organization.

`201`

status

string

The outcome of the create request

enum:

"created""error"

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:

My Webhook

description

string

An optional description of the webhook

example:

Webhook for failed syncs

events

array

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

example:

[ "sync.alert.raised", "sync.alert.resolved" ]

type:

string

endpoint

stringrequired

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

integer

The id of the webhook.

example:

123

secret

string

The secret used to sign the webhook payload. Can be used to verify the authenticity of the webhook.

example:

my123secret

`400`

status

string

The outcome of the request

enum:

"error"

message

string

The reason the request failed

example:

endpoint must be a HTTPS URL

`401`

status

integer

HTTP status code.

enum:

"401"

`403`

status

integer

HTTP status code.

enum:

"403"

message

string

Error message.

example:

The feature you're trying to use is not available for your organization.

{
  "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"
  }
}