Webhook Template

What can you do with WebhookTemplate?


Properties

Property Details
id
"id": 661
Type: Number
This is the unique numeric identifier for the WebhookTemplate
ownerId
"ownerId": 402
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
requestBody
"requestBody": "Hello World"
Type: String
eventRegistrationId
"eventRegistrationId": 722
Type: Number
Unique identifier for the associated EventRegistration object.
localeId
"localeId": 618
Type: Number
Unique identifier for the associated Locale object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • requestBody
  • eventRegistrationId
  • localeId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Webhook/Template/{id:int}
Delete an instance of the WebhookTemplate object.
GETapi/v1/Webhook/Template
Retrieve all of the WebhookTemplate objects.
GETapi/v1/Webhook/Template/Metadata
Retrieve all of the meta data details of the WebhookTemplate object.
GETapi/v1/Webhook/Template/Metadata/{option}
Retrieve all the meta data details of the WebhookTemplate object based on provided options.
{option}Metadata options for the WebhookTemplate object.
GETapi/v1/Webhook/Template/Paged
Retreive all of the WebhookTemplate objects in a paged fashion.
GETapi/v1/Webhook/Template/{id:int}
Retrieve an instance of the WebhookTemplate object by it's ID.
{id:int}Unique identifier for the WebhookTemplate object.
POSTapi/v1/Webhook/Template
Create a new instance of the WebhookTemplate object.
PUTapi/v1/Webhook/Template/{id:int}
Update an existing instance of the WebhookTemplate object.