Patch Webhooks Subscription

Patch Webhooks Subscription

This API enables user to update the existing webhook subscription.

Request
URI
PATCH
https://{api_host}/tcsa/api/webhooks/v1/subscriptions/{id}
COPY
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.

object
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.
Responses
200

Ok

Returns SubscriptionModel of type(s) application/json 
"SubscriptionModel Object"
string
id
Optional

Unique subscrpiton id .

string
name
Optional

Name of the subscription.

string
app_id
Optional

Id of the internal application .

boolean
disabled
Optional

Subscription is active or inactive

integer
start_time
Optional

Subscription start time.

integer
update_time
Optional

Subscription update time.

string
user_name
Optional

User who had created the subscription.

string
type
Optional

The type of subscription.

string
description
Optional

Detail description about the subscription.

string
url
Optional

The URL set to receive notifications.

object
headers
Optional

Headers set for subscription.

object
vsafilter
Optional

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


404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Webhook Operations
POST
Create Webhook Subscription
GET
Get All Webhook Subscription
PATCH
Patch Webhooks Subscription
GET
Get Webhook Subscription
DELETE
Delete Webhook Subscription