In this guide you can find the expected payloads for each of our project webhook events, for more information on creating and managing webhooks within your Content Workflow project see this guide.

Available Events & Payloads

Many of our webhook payloads share the same schema, and only differ by event type. We've grouped the payload examples below; you can expect the payload.data to be the same between events, and only the payload.event to differ.

Payload Type	Event Trigger	System Name
Comment Payload	Conversation was started Comment was added to an item Comment was edited Comment was deleted	`ConversationWasStarted` `CommentWasAdded` `CommentWasEdited` `CommentWasDeleted`
Resolved Conversation Payload	Conversation was resolved	`ConversationWasResolved`
Item Payload	Item has become overdue Item was created User was assigned to an item Item structure was altered	`ItemOverdue` `ItemCreated` `ItemAssigneesUpdated` `ItemStructureWasChanged`
Item Status Changed Payload	Item status was changed	`ItemStatusWasChanged`
Shareable Link Payload	Shareable link was generated	`ShareableLinkWasGenerated`
Workflow Step Payload	Workflow step was created Workflow step was updated Workflow step was deleted	`WorkflowStatusWasCreated` `WorkflowStatusWasUpdated` `WorkflowStatusWasRemoved`
Item Structure Payload	Item structure was changed Template was created	`ItemStructureWasChanged` `TemplateWasCreated`

Comment Payload

{
  "payload": {
    "event": "ConversationWasStarted",
    "data": {
      "item_id": 15742132,
      "content": null,
      "message": "@peaks: Hey this looks great",
      "author": {
        "id": 92967,
        "name": "James Deer",
        "avatar": "https://gathercontent-avatars.imgix.net/92967_RgRgM4v4p6N9nFDO1Kv5dCxGUP2FAL6EhJuNEt9q146JEgRPcUSA38SMx9PLokL9.png?s=de4b7e81dadc88a44906a1aa41ed9d81",
        "username": "jamesdeer21"
      },
      "tagged_users": {
        "25": {
          "id": 300947,
          "name": "James Peacock",
          "avatar": "https://gathercontent-avatars.imgix.net/300947_hZYqi3CWBo6sYxb3lyOq1KXpuS0eMlLUf8QEwaLouFgJwcxAGeIg9dPshN7mftrz.jpg?s=82bca3124b0206f74d2c9d2f4ed79e57",
          "username": "peaks"
        }
      },
      "conversation_url": "https://acmecorp.gathercontent.com/item/15742132?conversationId=88693b5f-37cf-9ec1-30c0-18cefc084bca",
      "created_at": 1715610997,
      "updated_at": 1715610997
    }
  }
}

Resolved Conversation Payload

{
  "payload": {
    "event": "ConversationWasResolved",
    "data": {
      "conversation_id": "88693b5f-37cf-9ec1-30c0-18cefc084bca",
      "item_id": 15742132,
      "content": null,
      "resolved_by": {
        "id": 92967,
        "name": "James Deer",
        "avatar": "https://gathercontent-avatars.imgix.net/92967_RgRgM4v4p6N9nFDO1Kv5dCxGUP2FAL6EhJuNEt9q146JEgRPcUSA38SMx9PLokL9.png?s=de4b7e81dadc88a44906a1aa41ed9d81",
        "username": "jamesdeer21"
      },
      "conversation_url": "https://acmecorp.gathercontent.com/item/15742132?conversationId=88693b5f-37cf-9ec1-30c0-18cefc084bca",
      "created_at": 1715610997,
      "updated_at": 1715611161
    }
  }
}

Item Payload

This webhook includes an item's structure definition, more information on this see the recipe below:

🦉

Structure Definition

Open Recipe

{
  "payload": {
    "event": "ItemAssigneesUpdated",
    "data": {
      "id": 3633864,
      "project_id": 54006,
      "folder_uuid": "ab775915-d395-4e6b-bf0d-b91b87b53c58",
      "structure_uuid": "e66eee24-0368-44f2-81c9-84aa334d1632",
      "template_id": 533759,
      "position": 10,
      "name": "Managing your Account",
      "status_id": 279963,
      "archived_by": null,
      "archived_at": null,
      "next_due_at": null,
      "completed_at": null,
      "assigned_users": [
        {
          "id": 359493,
          "email": "[email protected]",
          "first_name": "Hugh",
          "last_name": "Downer"
        }
      ],
      "assigned_user_ids": [
        359493
      ],
      "current_workflow_assigned_user_ids": [],
      "assignee_count": 1,
      "updated_at": "2024-05-13 14:41:49",
      "created_at": "2016-12-08 12:04:07",
      "structure": {
        "uuid": "e66eee24-0368-44f2-81c9-84aa334d1632",
        "groups": [
          {
            "uuid": "fd3f6fa8-0d19-43f7-b088-6a76a0bac3ee",
            "name": "Content",
            "fields": [
              {
                "uuid": "45aaf6f4-5ca4-4162-9ccc-71fa40b31319",
                "label": "Collection title",
                "instructions": "",
                "field_type": "text",
                "metadata": {
                  "is_plain": true,
                  "validation": null
                }
              },
              {
                "uuid": "1252b27a-7ae0-4f52-9ed1-e5029f4dd29e",
                "label": "Collection description",
                "instructions": "",
                "field_type": "text",
                "metadata": {
                  "is_plain": false,
                  "validation": null
                }
              }
            ]
          }
        ]
      }
    }
  }
}

Item Status Changed Payload

{
  "payload": {
    "event": "ItemStatusWasChanged",
    "data": {
      "id": 3633864,
      "project_id": 54006,
      "folder_uuid": "ab775915-d395-4e6b-bf0d-b91b87b53c58",
      "structure_uuid": "e66eee24-0368-44f2-81c9-84aa334d1632",
      "template_id": 533759,
      "position": 10,
      "name": "Managing your Account",
      "status_id": 325989,
      "archived_by": null,
      "archived_at": null,
      "next_due_at": null,
      "completed_at": null,
      "assigned_users": [
        {
          "id": 359493,
          "email": "[email protected]",
          "first_name": "Hugh",
          "last_name": "Downer"
        }
      ],
      "assigned_user_ids": [
        359493
      ],
      "current_workflow_assigned_user_ids": [],
      "assignee_count": 1,
      "updated_at": "2024-05-13 14:43:56",
      "created_at": "2016-12-08 12:04:07",
      "itemId": 3633864,
      "changedById": 92967,
      "statusId": 325989,
      "statusName": "Published and needs updating",
      "statusColor": "#ffff00"
    }
  }
}

Shareable Link Payload

{
  "payload": {
    "event": "ShareableLinkWasGenerated",
    "data": {
      "id": "Qb0YelsUH4uy47U1",
      "item_id": 17681760,
      "enabled": true,
      "settings": {
        "comments": true,
        "approvals": true,
        "editing": true,
        "show_guidelines_and_instructions": true
      },
      "created_at": "2024-05-13 14:56:36",
      "updated_at": "2024-05-13 14:56:36"
    }
  }
}

Workflow Step Payload

{
  "payload": {
    "event": "WorkflowStatusWasUpdated",
    "data": {
      "status": {
        "id": 221002,
        "name": "New Article",
        "position": 1,
        "colour": "#f0f0f0",
        "updated_by": 92967
      },
      "workflow": [
        {
          "id": 279961,
          "name": "Initial Review",
          "colour": "#f20ed7"
        },
        {
          "id": 279963,
          "name": "Published",
          "colour": "#0dff00"
        },
        {
          "id": 325989,
          "name": "Published and needs updating",
          "colour": "#ffff00"
        },
        {
          "id": 1204304,
          "name": "Published and needs updating BLOCKED",
          "colour": "#faa732"
        },
        {
          "id": 1204305,
          "name": "Drafting",
          "colour": "#0e90d2"
        },
        {
          "id": 1240086,
          "name": "Offline (Draft in Intercom)",
          "colour": "#81918b"
        },
        {
          "id": 1793847,
          "name": "Ready to publish in Intercom",
          "colour": "#3b4211"
        },
        {
          "id": 2136519,
          "name": "Review- Customer View",
          "colour": "#faa732"
        },
        {
          "id": 2136520,
          "name": "Approved",
          "colour": "#954f99"
        },
        {
          "id": 2136521,
          "name": "Design Review",
          "colour": "#0e90d2"
        }
      ]
    }
  }
}

Item Structure Payload

This webhook includes an item's structure definition, more information on this see the recipe below:

🦉

Structure Definition

Open Recipe

{
  "payload": {
    "event": "TemplateWasChanged",
    "data": {
      "id": 533759,
      "name": "Collection",
      "number_of_items_using": 11,
      "structure_uuid": "e66eee24-0368-44f2-81c9-84aa334d1632",
      "project_id": 54006,
      "updated_at": "2024-05-13 14:51:15",
      "updated_by": 92967,
      "structure": {
        "uuid": "e66eee24-0368-44f2-81c9-84aa334d1632",
        "groups": [
          {
            "uuid": "fd3f6fa8-0d19-43f7-b088-6a76a0bac3ee",
            "name": "Content",
            "fields": [
              {
                "uuid": "45aaf6f4-5ca4-4162-9ccc-71fa40b31319",
                "label": "Collection title",
                "instructions": "",
                "field_type": "text",
                "metadata": {
                  "is_plain": true,
                  "validation": null,
                  "repeatable": {
                    "limit": 2,
                    "isRepeatable": false,
                    "limitEnabled": false
                  }
                }
              },
              {
                "uuid": "1252b27a-7ae0-4f52-9ed1-e5029f4dd29e",
                "label": "Collection description",
                "instructions": "",
                "field_type": "text",
                "metadata": {
                  "is_plain": false,
                  "validation": null,
                  "repeatable": {
                    "limit": 2,
                    "isRepeatable": false,
                    "limitEnabled": false
                  }
                }
              }
            ]
          }
        ]
      }
    }
  }
}