The Webhook Object

This is an object representing webhooks in a space.

Properties

id
number

The numeric ID of the webhook
name
string

Name of this webhook
description
string

A brief description of this webhook
endpoint
string

Webhook endpoint
space_id
number

Numeric ID of a space
secret
string

Webhook secret

actions

enum[]

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

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

activated
boolean

Activate or deactivate the current webhook. Default: true when creating a webhook
deleted_at
string

Deleted date (Format: YYYY-mm-dd HH:MM)
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)

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