WebHooks

How Suptask can trigger a WebHook

Suptask can trigger a HTTPS Webhook request to an endpoint of your choice when certain events are occuring in Suptask.

Events

  • Created Ticket

  • Updated Ticket

  • New Reply/Comment on a Ticket

Sample event data

You can find sample data below with the current structure of the WebHook request.

Created

{
    "ticket": {
        "ticketNumber": "42",
        "teamTicketId": "zenithops-42",
        "followers": {},
        "teamName": "Zenith Corp",
        "queueId": "a73ee310-c1fe-4abc-9374-82d8d123a9fc",
        "formId": "f71dd3b1-6f43-4f1f-a832-d1bd4c7ed9b7",
        "messageResponderId": "2850112358.998112",
        "status": "OPEN",
        "messageRequesterId": "2850048932.761432",
        "updatedBy": "U01XZGTRPL8",
        "messageResponderCount": 0,
        "teamId": "T02ZXY1B2MN",
        "createdBy": "U01XZGTRPL8",
        "requesterId": "U01MLKU9XZB",
        "isCollaborationTicket": false,
        "archived": false,
        "messageLastRequesterTime": 2850112357,
        "id": "b2e41bde-78c2-4c09-bf6d-0b37a12e50fc",
        "isSlackConnect": false,
        "tags": [],
        "messageLastRespondTime": 2850112357,
        "teamDomain": "zenithops",
        "__typename": "Ticket",
        "requesterTicketPermalink": "https://zenithops.slack.com/archives/C09JH1RMXTY/p2850048932761432?thread_ts=2850036102.054312&cid=C09JH1RMXTY",
        "messageRequesterCount": 0,
        "assignee": "UNASSIGNED",
        "responderTicketPermalink": "https://zenithops.slack.com/archives/C09JK2D3JQZ/p2850112358998112",
        "createdAt": 2850112357,
        "attachments": [],
        "messageRequesterChannel": "C09JH1RMXTY",
        "source": "slack",
        "formValues": [
            {
                "value": "Review the new AI models submitted yesterday",
                "fieldName": "description"
            },
            {
                "value": "Deeplogix",
                "fieldName": "organization"
            },
            {
                "value": "OPEN",
                "fieldName": "status"
            }
        ],
        "summaryTitle": null,
        "messageResponderChannel": "C09JK2D3JQZ",
        "messages": [],
        "updatedAt": 2850112357,
        "summarySolution": null,
        "summaryProblem": null,
        "description": "Review the new AI models submitted yesterday",
        "approvers": {}
    },
    "displayFields": {
        "assignees": [],
        "requester": [
            {
                "id": "U01MLKU9XZB",
                "displayName": "Jordan Mendes"
            }
        ],
        "descriptionUserMap": {},
        "organization": "Deeplogix"
    }
}

Updated

{
    "ticket": {
        "ticketNumber": "847",
        "teamTicketId": "zenith-847",
        "followers": {},
        "teamName": "Zenith Corp",
        "queueId": "c9edab55-a3f1-4abc-b834-9f78e3cd0e4a",
        "formId": "9f42db38-3f45-41f7-b123-972f3d6542c1",
        "messageResponderId": "2847392847.184739",
        "status": "CLOSED",
        "messageRequesterId": "2847392846.984321",
        "updatedBy": "U01XZGTRPL8",
        "messageResponderCount": 1,
        "teamId": "T02ZXY1B2MN",
        "createdBy": "U01XZGTRPL8",
        "closedDate": "2025-06-11T13:45:20.001Z",
        "extTicketRef": [
            "T02ZXY1B2MN-992384"
        ],
        "requesterId": "U01XZGTRPL8",
        "responderThreadPermalink": "https://zenithops.slack.com/archives/C09JK2D3JQZ/p2847392847184739?thread_ts=2847392847.184739&cid=C09JK2D3JQZ",
        "isCollaborationTicket": false,
        "archived": false,
        "messageLastRequesterTime": 2847392848,
        "id": "bb45d113-09a1-4ff9-b372-6e45b971ccf8",
        "isSlackConnect": false,
        "tags": ["question"],
        "messageLastRespondTime": 2847392859,
        "teamDomain": "zenithops",
        "__typename": "Ticket",
        "requesterActionTs": "2847392848.284392",
        "requesterTicketPermalink": "https://zenithops.slack.com/archives/C09JH1RMXTY/p2847392846984321",
        "requesterThreadPermalink": "https://zenithops.slack.com/archives/C09JH1RMXTY/p2847392847284392?thread_ts=2847392846.984321&cid=C09JH1RMXTY",
        "messageRequesterCount": 1,
        "assignee": "U06YTRAB1VZ",
        "responderTicketPermalink": "https://zenithops.slack.com/archives/C09JK2D3JQZ/p2847392847184739",
        "createdAt": 2847392846,
        "attachments": [],
        "messageRequesterChannel": "C09JH1RMXTY",
        "source": "slack",
        "formValues": [
            {
                "value": "UNASSIGNED",
                "fieldName": "assignee"
            },
            {
                "value": "CRITICAL",
                "fieldName": "priority"
            }
        ],
        "summaryTitle": null,
        "messageResponderChannel": "C09JK2D3JQZ",
        "messages": [
            {
                "responderTs": [
                    "2847392847.658329"
                ],
                "initiator": "REQUESTER",
                "requesterTs": [
                    "2847392846.984321"
                ]
            },
            {
                "responderTs": [
                    "2847392858.213847"
                ],
                "initiator": "RESPONDER",
                "requesterTs": [
                    "2847392859.102938"
                ]
            }
        ],
        "updatedAt": 2847392875,
        "summarySolution": null,
        "summaryProblem": null,
        "description": "Hi, I need help with my laptop",
        "approvers": {}
    },
    "displayFields": {
        "assignees": [
            {
                "id": "U06YTRAB1VZ",
                "displayName": "andrea"
            }
        ],
        "requester": [
            {
                "id": "U01XZGTRPL8",
                "displayName": "Customer Care"
            }
        ],
        "descriptionUserMap": {},
        "organization": null,
        "firstReplyTime": "2025-06-11T13:42:31.000Z"
    }
}

New Reply/Comment

{
    "ticket": {
        "ticketNumber": "5931",
        "teamTicketId": "zenithops-5931",
        "followers": {},
        "teamName": "Zenith Operations",
        "queueId": "c8feab11-f7c2-40df-8421-df32e6030e9b",
        "formId": "8732af22-a1cd-4c65-a113-b732ae47e2f4",
        "messageResponderId": "2850193845.103847",
        "status": "IN_PROGRESS",
        "messageRequesterId": "2850193844.928374",
        "updatedBy": "U01XZGTRPL8",
        "messageResponderCount": 0,
        "teamId": "T02ZXY1B2MN",
        "createdBy": "U01XZGTRPL8",
        "extTicketRef": [
            "T02ZXY1B2MN-883421"
        ],
        "requesterId": "U01XZGTRPL8",
        "responderThreadPermalink": "https://zenithops.slack.com/archives/C09JK2D3JQZ/p2850193845103847?thread_ts=2850193845.103847&cid=C09JK2D3JQZ",
        "isCollaborationTicket": false,
        "archived": false,
        "messageLastRequesterTime": 2850193846,
        "id": "a9b6c003-25e1-4f79-8d83-108fb321fa2d",
        "isSlackConnect": false,
        "tags": [],
        "messageLastRespondTime": 2850193844,
        "teamDomain": "zenithops",
        "__typename": "Ticket",
        "requesterActionTs": "2850193846.204981",
        "requesterTicketPermalink": "https://zenithops.slack.com/archives/C09JH1RMXTY/p2850193844928374",
        "requesterThreadPermalink": "https://zenithops.slack.com/archives/C09JH1RMXTY/p2850193846204981?thread_ts=2850193844.928374&cid=C09JH1RMXTY",
        "messageRequesterCount": 1,
        "assignee": "UNASSIGNED",
        "responderTicketPermalink": "https://zenithops.slack.com/archives/C09JK2D3JQZ/p2850193845103847",
        "createdAt": 2850193844,
        "attachments": [],
        "messageRequesterChannel": "C09JH1RMXTY",
        "source": "slack",
        "formValues": [
            {
                "value": "UNASSIGNED",
                "fieldName": "assignee"
            },
            {
                "value": "MEDIUM",
                "fieldName": "priority"
            }
        ],
        "summaryTitle": null,
        "messageResponderChannel": "C09JK2D3JQZ",
        "messages": [
            {
                "responderTs": [
                    "2850193845.748392"
                ],
                "initiator": "REQUESTER",
                "requesterTs": [
                    "2850193844.928374"
                ]
            }
        ],
        "updatedAt": 2850193848,
        "summarySolution": null,
        "summaryProblem": null,
        "description": "Can you help me with the access to the new service?",
        "approvers": {}
    },
    "externalTickets": [
        {
            "external": {
                "ticketId": "883421",
                "url": "zenithops.zendesk.com/agent/tickets/883421"
            },
            "version": 2,
            "modified": "2025-06-11T13:43:01.214Z",
            "object": {
                "link": "https://zenithops.zendesk.com/agent/tickets/883421"
            },
            "suptask": {
                "type": "Zendesk",
                "teamId": "T02ZXY1B2MN"
            },
            "created": "2025-06-11T13:43:01.214Z",
            "teamId": "T02ZXY1B2MN",
            "suptaskTicketId": "a9b6c003-25e1-4f79-8d83-108fb321fa2d",
            "id": "T02ZXY1B2MN-883421",
            "entity": "ExternalTicket"
        }
    ],
    "user": {
        "id": "U06YTRAB1VZ",
        "name": "andrea",
        "email": "[email protected]"
    },
    "text": "_Synced from Suptask_\n\nandrea:\nHola",
    "rawText": "Hola",
    "dispatchedFrom": "responder"
}

Last updated

Was this helpful?