Patch Webhooks Subscription

This API enables user to update the existing webhook subscription.

Request

URI

PATCH

https://{api_host}/tcsa.host.com/tcsa/api/webhooks/v1/subscriptions/{id}

COPY

Path Parameters

string

Required

The id of webhook.

Request Body

Request to update subscription.

UpdateSubscriptionRequest of type(s) application/json

Required

{
    "url": "string",
    "description": "string",
    "headers": {
        "headers": "string"
    },
    "vsafilter": {
        "condition": "AND",
        "filterlist": [
            "Filter Object"
        ]
    },
    "disabled": false
}

string

url

Optional

The URL where user wants to receive notifications.

string

description

Optional

Details description about the subscription.

object

headers

Optional

Headers user wants to receive with notifications.

VsaFilter

vsafilter

Optional

The VSAFilter object defines how the filters has to be applied on queries.

boolean

disabled

Optional

Setting this to true, disables the subscription.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns SubscriptionModel of type(s) application/json

{
    "id": "ep_2U6LKqlSiXEyCZjZT9LCuuLlxw5",
    "name": "router-wh",
    "app_id": "app_2U68Bt1IxHidF3OT8qeEMM3ETub",
    "disabled": false,
    "start_time": 1692255023421,
    "update_time": 1692255023421,
    "user_name": "oper",
    "type": "NOTIFICATION",
    "description": "webhook to get router events",
    "url": "https://play.svix.com/in/e_y1sI1Dy8IvkYQcgYQy5yoHAtR7E/",
    "headers": null,
    "vsafilter": {
        "filterlist": [
            {
                "condition": "OR",
                "propfilter": [
                    {
                        "propname": "ClassName",
                        "matchtype": "EQ",
                        "values": [
                            "Router"
                        ]
                    }
                ]
            }
        ]
    }
}

string

Optional

Unique subscrpiton id .

string

name

Optional

Name of the subscription.

string

app_id

Optional

Id of the internal application .

boolean