Webhook / Configuration

What can you do with WebhookConfiguration?


Properties

Property Details
id
"id": 474
Type: Number
This is the unique numeric identifier for the WebhookConfiguration
name
"name": "Hello World"
Type: String
uRL
"uRL": "Hello World"
Type: String
requestVerb
"requestVerb": "Hello World"
Type: String
webhookTemplateId
"webhookTemplateId": 263
Type: Number
Unique identifier for the associated WebhookTemplate object.
authorizationTokenKey
"authorizationTokenKey": "Hello World"
Type: String
authorizationTokenValue
"authorizationTokenValue": "Hello World"
Type: String
eventSubscriptionId
"eventSubscriptionId": 533
Type: Number
Unique identifier for the associated EventSubscription 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
  • url
  • requestVerb
  • webhookTemplateId
  • authorizationTokenKey
  • authorizationTokenValue
  • eventSubscriptionId

DataFlow PATCH objects:


End Points

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