List Events

POST

https://webhooks.smartsuite.com/smartsuite.webhooks.engine.Webhooks/ListEvents

Lists all SmartSuite Webhooks

Example Request

curl -X POST https://webhooks.smartsuite.com/smartsuite.webhooks.engine.Webhooks/ListEvents \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "ACCOUNT-ID: WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "webhook_id": "{{webhook_id}}",
  "page_size": "50",
  "page_token": ""
}'

Request Body

Param	Type	Optional	Description
webhook_id	string	Yes	Specifies a webhook Id to return events for.
page_size	string	Yes	Number of records per page
page_token	string	Yes	Use next_page_token to fetch the next page of events

Response

Param	Type	Description
events	array of event objects	Array of events
next_page_token	string	Token used to request the next page of event data

event object structure

Param	Type	Description
webhook_id	string	The event's webhook Id
locator	locator object	No
event_id	string	The event's Id
kind	string	The event type
event_at	datetime	Event's ISO datetime
record_event_data	event data object	Event's record data
ctx	ctx object	information about the event

locator object

Param	Type	Description
locator.account_id	object	No
locator.solution_id	object	No
locator.application_id	object	No

event_data object

Param	Type	Description
record_id	string	The record Id
locator	locator object	Contains workspace and Solution information
data	field data object	Event data
previous	field data object	Prior values of fields when event type is RECORD_UPDATED

field data object

Param	Type	Description
1-n... field_slug	field object	SmartSuite field objects and their data

ctx object

Param	Type	Description
change_id	string	id of the change event
change_size	number	size of the change event
batch_id	string	id of the event batch
batch_size	number	size of the event batch
source	string	Source of the change event
handler	string	change event handler name

---

Example Response - 200

{
    "events": [
        {
            "webhook_id": "2f7cc6e0-b709-4b04-964a-3706c89c78e3",
            "locator": {
                "account_id": "WORKSPACE_ID",
                "solution_id": "63b87cad645b3949631b55bf"
            },
            "event_id": "2f7cc6e0-b709-4b04-964a-3706c89c78e3.994",
            "kind": "RECORD_CREATED",
            "event_at": "2023-06-21T21:14:06.263Z",
            "record_event_data": {
                "record_id": "6493681eba09b400816eb754",
                "locator": {
                    "account_id": "WORKSPACE_ID",
                    "solution_id": "63b87cad645b3949631b55bf",
                    "application_id": "63b87cad645b3949631b55c1"
                },
                "data": {
                    "last_updated": {
                        "on": "2023-06-21T21:14:06.247000Z",
                        "by": "63a1f65723aaf6bcb564b1f1"
                    },
                    "due_date": {
                        "is_overdue": false,
                        "status_updated_on": "2023-06-21T21:14:06.248000Z",
                        "from_date": {
                            "date": null,
                            "include_time": false
                        },
                        "to_date": {
                            "date": null,
                            "include_time": false
                        },
                        "status_is_completed": false
                    },
                    "description": {
                        "data": {
                            "type": "doc",
                            "content": []
                        },
                        "preview": "",
                        "html": "<div class=\"rendered\">\n    \n</div>"
                    },
                    "deleted_by": null,
                    "title": "test",
                    "priority": "",
                    "application_id": "63b87cad645b3949631b55c1",
                    "followed_by": [],
                    "application_slug": "ssb9kaxn",
                    "deleted_date": {
                        "date": null,
                        "include_time": false
                    },
                    "comments_count": 0,
                    "autonumber": 2,
                    "ranking": {
                        "default": "aagckvkhyq"
                    },
                    "id": "6493681eba09b400816eb754",
                    "first_created": {
                        "on": "2023-06-21T21:14:06.247000Z",
                        "by": "63a1f65723aaf6bcb564b1f1"
                    },
                    "assigned_to": [],
                    "status": {
                        "updated_on": "2023-06-21T21:14:06.248000Z",
                        "value": "backlog"
                    }
                },
                "previous": {}
            },
            "ctx": {
                "change_id": "ba1ffa93-0c51-48ab-aff2-64d9128d6c35",
                "change_size": 1,
                "batch_id": "65832e55206fdfd247b84abd",
                "batch_size": 1,
                "source": "UNKNOWN",
                "handler": "INTERACTIVE"
            }
        }
    ],
    "next_page_token": "8991625"
}