Update webhook

Update 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

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

PATCH

https://app.getcensus.com/api/v1/webhooks/{webhook_id}

PATCH /api/v1/webhooks/{webhook_id} 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

200

Webhook updated successfully

400

Bad Request

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 request

enum:

"updated""not_found""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

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

`404`

status

integer

HTTP status code.

enum:

"404"

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