Create Webhook Template

Create Webhook Template

Attach custom template to the webhook.

Request
URI
POST
https://{api_host}/api/notification/{orgId}/webhooks/{webhook}/template
COPY
Path Parameters
string
orgId
Required

Org ID

string
webhook
Required

Webhook identifier

Query Parameters
string
action
Required

Actions
create_new: Creates a new webhook custom template.
restore_default: Revert webhook template to the default.

Possible values are : create_new, restore_default,

Request Body
WebhookTemplate of type(s) application/json
Required
{
    "template": "string"
}
string
template
Optional

Payload template for the webhook notification.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns WebhookTemplate of type(s) application/json
"WebhookTemplate Object"
string
template
Optional

Payload template for the webhook notification.


400

Bad Request

Returns ErrorResponse of type(s) application/json
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


401

Unauthorized

Returns WebhookTemplate of type(s) application/json
"WebhookTemplate Object"
string
template
Optional

Payload template for the webhook notification.


403

Forbidden

Returns WebhookTemplate of type(s) application/json
"WebhookTemplate Object"
string
template
Optional

Payload template for the webhook notification.


404

Not Found

Returns ErrorResponse of type(s) application/json
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


500

Internal Server Error

Returns ErrorResponse of type(s) application/json
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/notification/{orgId}/webhooks/{webhook}/template