Webhook

Update a webhook endpoint

Update a webhook endpoint by its ID.

patch/webhook-endpoints/{webhook_endpoint_id}

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/webhook-endpoints/{webhook_endpoint_id}
  • Auth: HTTP basic

Path parameters

webhook_endpoint_idstring required

Request body

descriptionstring

A description for this webhook endpoint.

enabled_eventsstring[]

A list of events and event types which will be sent to this webhook's URL.

is_disabledboolean

Set to true to disable this webhook endpoint from receiving events.

urlstring

The HTTPS URL that webhooks will be delivered to.

Response

Successful response

created_atstring date-time required

Date (format: YYYY-MM-DD) on which the event was emitted

descriptionstring required

A description for this webhook

enabled_eventsstring[] required

A list of events and event types which are being sent to this webhook's URL

idstring required

The unique ID of the object

is_disabledboolean required

Indicates whether this webhook URL is actively receiving events

secretstring required

Secret key which allows you to verify that the event was sent by Column, and not by a third party

updated_atstring date-time required

Timestamp of when this webhook was last updated

urlstring required

The HTTPS URL that webhooks will be delivered to. e.g. https://yoursite.com/column-events

Changes

No recorded changes to this operation across all 1 revision of this API.