Create Webhook Subscription

This API enables user to create a webhook subscription for receiving notifications.

Request

URI

POST

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

COPY

Request Body

Request to create webhook subscription.

SubscriptionRequest of type(s) application/json

Required

Show optional properties

{
    "name": "router-wh",
    "description": "webhook to get router events",
    "url": "https://play/in/e_y1sI1Dy8IvkYQcgYQy5yoHAtR7E/",
    "vsafilter": {
        "filterlist": [
            {
                "condition": "OR",
                "propfilter": [
                    {
                        "propname": "ClassName",
                        "matchtype": "EQ",
                        "values": [
                            "Router"
                        ]
                    }
                ]
            }
        ]
    }
}

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

string As ^[a-zA-Z0-9_-]+$

name

Required

unique name for subscription

string

description

Required

Description about the webhook

string As ^(https?)://[^\s/$.?#].[^\s]*$

url

Required

A publicly accessible URL where user wants to receive notifications

object

headers

Optional

Additional headers users wants to receive along with notification

VsaFilter

vsafilter

Required

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

boolean

disabled

Optional

Defines subscriptions is active or inactive.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

201

Created

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