# Webhooks

#Available from v.3.11.0 Webhooks are used to notify external systems of changes within Struct PIM through a web request

GET /webhooks Get all configured webhooks

Response status OK (200)

array : WebhookModel
WebhookModel
Property name Data type Description
Uid string

Unique id of webhook

Title string

Title of webhook

Url string

Url for the webhook to request when triggered

Active boolean

Activate / deactivate webhook

EnabledEvents array

Events this webhook shall act on

AdvancedSettings object

Advanced settings for events supporting this

RequestHeaders array : RequestHeader

Request headers to be added to webhook requests

RequestHeader
Property name Data type Description
Name string
Value string

PUT /webhooks Update a webhook

Request parameters

Property name Parameter type Data type Description
webhook body object : WebhookModel

Webhook to update

WebhookModel
Property name Data type Description
Uid string

Unique id of webhook

Title string

Title of webhook

Url string

Url for the webhook to request when triggered

Active boolean

Activate / deactivate webhook

EnabledEvents array

Events this webhook shall act on

AdvancedSettings object

Advanced settings for events supporting this

RequestHeaders array : RequestHeader

Request headers to be added to webhook requests

RequestHeader
Property name Data type Description
Name string
Value string

Response status OK (200)

No body message is returned

POST /webhooks Create a new webhook

Request parameters

Property name Parameter type Data type Description
webhook body object : WebhookModel

Webhook to create

WebhookModel
Property name Data type Description
Uid string

Unique id of webhook

Title string

Title of webhook

Url string

Url for the webhook to request when triggered

Active boolean

Activate / deactivate webhook

EnabledEvents array

Events this webhook shall act on

AdvancedSettings object

Advanced settings for events supporting this

RequestHeaders array : RequestHeader

Request headers to be added to webhook requests

RequestHeader
Property name Data type Description
Name string
Value string

Response status OK (200)

No body message is returned

GET /webhooks/{uid} Get a webhook

#Available from v.3.11.0

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of webhook

Response status OK (200)

object : WebhookModel
WebhookModel
Property name Data type Description
Uid string

Unique id of webhook

Title string

Title of webhook

Url string

Url for the webhook to request when triggered

Active boolean

Activate / deactivate webhook

EnabledEvents array

Events this webhook shall act on

AdvancedSettings object

Advanced settings for events supporting this

RequestHeaders array : RequestHeader

Request headers to be added to webhook requests

RequestHeader
Property name Data type Description
Name string
Value string

DELETE /webhooks/{uid} Delete a webhook

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of webhook to delete

Response status OK (200)

No body message is returned

GET /webhooks/{webhookUid}/requests Get requests made from a webhook. Note that webhook requests are only stored for 14 days

Request parameters

Property name Parameter type Data type Description
webhookUid path string

Uid of webhook

since query string

return webhook requests newer than this timestamp

onlyFailed query boolean

Only return failed webhook requests

page query integer

Page to get (1 is first page)

Response status OK (200)

object : WebhookRequestSearchResult
WebhookRequestSearchResult
Property name Data type Description
WebhookRequests array : WebhookRequestModel

Webhook requests that matched the criteria

Page integer

Page of the search request

TotalHits integer

Total number of hits in the search

WebhookRequestModel
Property name Data type Description
Uid string

Unique id of this webhook request (Passed in the X-Request-UID header of the request)

WebhookUid string

Unique id of the webhook that triggered the request (Passed in the X-Hook-UID header of the request)

WebhookUrl string

Url that was called

EventKey string

The key of the event that triggered the event (Passed in the X-Event-Key header of the request)

EventTimestamp string

Timestamp of the event that triggered the webhook request

RequestTimestamp string

Timestamp of when the webhook request was made

RequestHeaders object

The request headers sent in the webhook request

RequestBody string

The request body sent in the webhook request

ElapsedMilliseconds integer

The time in ms it took to get a response from the recipient of the request

ResponseCode integer

The response code of the webhook request

ResponseHeaders object

The response headers received from the request

ParentWebhookRequestUid string

Uid of parent webhook request (only has value, if this is a retry of a failed webhook requeest)

IsRetry boolean

Indicates whether this request is a retry of a previously failed request


GET /webhooks/{webhookUid}/requests/{requestUid} Get a specific request made from a webhook. Note that webhook requests are only stored for 14 days

Request parameters

Property name Parameter type Data type Description
webhookUid path string

Uid of webhook

requestUid path string

Uid of webhook request

Response status OK (200)

object : WebhookRequestModel
WebhookRequestModel
Property name Data type Description
Uid string

Unique id of this webhook request (Passed in the X-Request-UID header of the request)

WebhookUid string

Unique id of the webhook that triggered the request (Passed in the X-Hook-UID header of the request)

WebhookUrl string

Url that was called

EventKey string

The key of the event that triggered the event (Passed in the X-Event-Key header of the request)

EventTimestamp string

Timestamp of the event that triggered the webhook request

RequestTimestamp string

Timestamp of when the webhook request was made

RequestHeaders object

The request headers sent in the webhook request

RequestBody string

The request body sent in the webhook request

ElapsedMilliseconds integer

The time in ms it took to get a response from the recipient of the request

ResponseCode integer

The response code of the webhook request

ResponseHeaders object

The response headers received from the request

ParentWebhookRequestUid string

Uid of parent webhook request (only has value, if this is a retry of a failed webhook requeest)

IsRetry boolean

Indicates whether this request is a retry of a previously failed request