Get Webhook Subscription

Get Webhook Subscription

This API retrieves the specific webhooks subscription details using id.

Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/webhooks/v1/subscriptions/{id}
COPY
Path Parameters
string
id
Required

The id of webhook.


Authentication
This operation uses the following authentication methods.
Responses
200

Ok

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
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.

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