Update Webhook

POST

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

Gets a webhook.

Example Request

curl -X POST https://webhooks.smartsuite.com/smartsuite.webhooks.engine.Webhooks/UpdateWebhook \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "ACCOUNT-ID: WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  --data '{
    "webhook": {
        "webhook_id": "2f7cc6e0-b709-4b04-964a-3706c89c78e3",
        "kinds": [
            1
        ],
        "locator": {
            "account_id": "{{accountId}}",
            "solution_id": "{{solutionId}}"
        },
        "filter": {
            "solution": {}
        },
        "notification_status": {
            "disabled": {}
        }
    }
}'

Request Body

Param	Type	Optional	Description
webhook_id	string	No	Id of webhook to update
kinds	array of strings	No	One of the following types of events: RECORD_CREATED RECORD_UPDATED RECORD_DELETED
locator	object	No	Contains workspace and Solution information
filter	object	No	Specifies a Solution Id to limit the returned webhooks.
notification_status	object	Yes

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"
                ]
          }

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

---

Response

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": {}
        }
    }
}