Get Webhook

POST

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

Gets a webhook.

Example Request

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

Request Body

Param	Type	Optional	Description
webhook_id	string	No	Id of the webhook you want to retrieve.

Response

Param	Type	Description
webhook_id	string	Webhook Id
locator	locator object	Contains workspace and Solution information
filter	filter object	Specifies a Solution Id to limit the returned webhooks.
kinds	array of strings	One of the following types of events: RECORD_CREATED RECORD_UPDATED RECORD_DELETED
created_at	created_at object	Created time information
updated_at	updated_at object	Updated time information
notification_status	notification_status object	Webhook notification status
system_status	system_status object	Webhook status

locator object

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

filter object

Param	Type	Optional	Description
solution	object	Yes*	Pass an empty object to filter at the Solution level
applications	applications filter object	Yes*	Object containing application (table) ids to filter by
application	application fields filter object	Yes*	object containing a list of Table (App) Ids to filter on

Filter: Solution level - no tables/fields

"filter": {
            "solution": {}
          }

Filter: Table (application) level

"filter": {
            "applications": {
                "application_ids": ["some application id"]
            }
          }

Filter: Field level

"filter": {
            "application": {
                "application_id": "some application id",
                "field_ids": [
                    "some field id 1",
                    "some field id 2"
                ]
          }

created_at object

Param	Type	Description
by	string	Creating user name
at	string	ISO date created

updated_at object

Param	Type	Description
by	string	Updating user name
at	string	ISO date updated

notification_status object

Param	Type	Description
enabled	notification_enabled object	Enables webhook notifications

notification_enabled object

Param	Type	Description
url	string	The webhook notification URL

system_status object

Param	Type	Description
enabled	enabled object	if exists, webhook is enabled
disabled	disabled object	if exists, webhook is disabled

enabled_object object

Param	Type	Description
expires_at	string	ISO date when webhook expires

disabled_object object

| Param | Type | Description | | expires_at | string | ISO date when webhook will be deleted |

Example Response - 200

{
    {
        "webhook_id": "3c8a1835-a39a-43ba-ba9c-6fbce5581e34",
        "locator": {
            "account_id": "WORKSPACE_ID",
            "solution_id": "641b70cb0d94c969a49983aa"
        },
        "filter": {
            "solution": {}
        },
        "kinds": [
            "RECORD_CREATED"
        ],
        "created_at": {
            "by": "Peter Novosel",
            "at": "2023-06-20T14:26:47.192Z"
        },
        "updated_at": {
            "by": "Peter Novosel",
            "at": "2023-06-20T14:26:47.192Z"
        },
        "notification_status": {
            "enabled": {
                "url": "https://sswebhooks.requestcatcher.com/"
            }
        },
        "system_status": {
            "enabled": {}
        }
    }
}