Create a webhook

Create a new webhook

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

group_id

stringrequired

The unique identifier of the group that this webhook belongs to

example:

wandering_aimlessly

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. If empty or omitted, all events are alerted on.

example:

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

type:

string

endpoint

stringrequired

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

example:

https://mycompany.com/fivetran-activation-sync-alerts

Http + 1.1

POST

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

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

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

Responses

201

Successfully created webhook.

400

Bad Request

401

Invalid credentials for the requested resource.

403

You are not authorized to use this feature or the feature is not available for your organization.

500

An error happened while processing the request.

`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.

group_id

stringrequired

The unique identifier of the group that this webhook belongs to

example:

wandering_aimlessly

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. If empty or omitted, all events are alerted on.

example:

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

type:

string

endpoint

stringrequired

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

example:

https://mycompany.com/fivetran-activation-sync-alerts

integerrequired

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. Fivetran will generate this secret automatically when the webhook is created. You should store this secret securely as it will not be retrievable after creation.

example:

abcdef1234567890abcdef1234567890

`400`

status

string

The outcome of the request

enum:

"error"

message

string

The reason the request failed

example:

endpoint must be an HTTPS URL

`401`

status

integer

HTTP status code.

enum:

"401"

`403`

status

integer

HTTP status code.

enum:

"403"

message

string

Error message.

`500`

status

integer

HTTP status code.

enum:

"500"

message

string

Description of the outcome.

example:

An unknown error occurred

{
  "status": "created",
  "data": {
    "group_id": "wandering_aimlessly",
    "name": "My Webhook",
    "description": "Webhook for failed syncs",
    "events": [
      "sync.alert.raised",
      "sync.alert.resolved"
    ],
    "endpoint": "https://mycompany.com/fivetran-activation-sync-alerts",
    "id": 123,
    "secret": "abcdef1234567890abcdef1234567890"
  }
}