The Webhook Object

This is an object representing webhooks in a space

Properties

id
number

The numeric ID
created_at
string

Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
updated_at
string

Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)
activated
boolean

Activate or deactivate the current webhook.
description
string

A brief description of this webhook
endpoint
string

Webhook endpoint
name
string

Name of this webhook
secret
string

Webhook secret
space_id
number

Numeric id of a space

actions

enum[]

Webhook triggers, at least one of the options listed below.

Triggers	Description
story.published	triggered when a story is published
story.unpublished	triggered, when a story is unpublished
story.deleted	triggered, when a story is deleted
story.moved	triggered when a story is moved from a folder or to a folder
datasource.entries_updated	triggered when a new datasource entry is saved or added.
asset.created	triggered when an asset is uploaded
asset.replaced	triggered when an asset is replaced
asset.deleted	triggered when an asset is deleted
asset.restored	triggered when an asset is restored
user.added	triggered when a new user is added to the space
user.removed	triggered when a user is removed from the space
user.roles_updated	triggered when a user role is updated
stage.changed	triggered when the workflow stage of a story changes.
pipeline.deployed	triggered when a pipeline stage is deployed
release.merged	triggered when a release is merged into the currently released content

Example Object

{
    "webhook_endpoint": {
        "id": 4569,
        "name": "Rebuild Website",
        "description": null,
        "endpoint": "https://apiendpoint.com",
        "space_id": 212319,
        "secret": "",
        "actions": [
            "story.published"
        ],
        "activated": true,
        "deleted_at": null,
        "created_at": "2024-03-04T07:58:29.513Z",
        "updated_at": "2024-03-04T07:58:29.513Z"
    }
}

Prev Introduction

Next Retrieve a Single Webhook