Events
get
Get event configurations
Responses
200
200 OK
application/json
get
/eventsGET /events HTTP/1.1
Host:
Accept: */*
200
200 OK
[
{
"id": "text",
"dateOfEvent": {
"$$field": "text",
"$$subfield": [
"text"
]
},
"title": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"fallbackTitle": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"summary": {
"fields": [
{
"emptyValueMessage": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"id": "text",
"value": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
]
},
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"actions": [
{
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"flags": [
{
"id": "text",
"operation": "add",
"conditional": null
}
],
"auditHistoryLabel": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"supportingCopy": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"conditionals": null,
"type": "text",
"review": {
"title": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"fields": [
{
"id": "text",
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"parent": {
"$$field": "text",
"$$subfield": [
"text"
]
},
"required": false,
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"secured": false,
"placeholder": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"validation": [
{
"validator": null,
"message": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
],
"helperText": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"hideLabel": false,
"uncorrectable": false,
"value": {
"$$field": "text",
"$$subfield": [
"text"
]
},
"analytics": false,
"type": "text",
"configuration": {
"lineSeparator": "text",
"fields": [
"country"
],
"administrativeLevels": [
"text"
],
"streetAddressForm": [
{
"id": "text",
"required": false,
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"type": "text",
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"parent": {
"$$field": "text",
"$$subfield": [
"text"
]
}
}
]
},
"defaultValue": {
"country": "text",
"streetLevelDetails": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"addressType": "text",
"administrativeArea": "123e4567-e89b-12d3-a456-426614174000"
}
}
]
}
}
],
"declaration": {
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"pages": [
{
"id": "text",
"title": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"fields": [
{
"id": "text",
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"parent": {
"$$field": "text",
"$$subfield": [
"text"
]
},
"required": false,
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"secured": false,
"placeholder": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"validation": [
{
"validator": null,
"message": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
],
"helperText": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"hideLabel": false,
"uncorrectable": false,
"value": {
"$$field": "text",
"$$subfield": [
"text"
]
},
"analytics": false,
"type": "text",
"configuration": {
"lineSeparator": "text",
"fields": [
"country"
],
"administrativeLevels": [
"text"
],
"streetAddressForm": [
{
"id": "text",
"required": false,
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"type": "text",
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"parent": {
"$$field": "text",
"$$subfield": [
"text"
]
}
}
]
},
"defaultValue": {
"country": "text",
"streetLevelDetails": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"addressType": "text",
"administrativeArea": "123e4567-e89b-12d3-a456-426614174000"
}
}
],
"conditional": null,
"type": "FORM"
}
]
},
"advancedSearch": [
{
"title": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"fields": [
{
"config": {
"type": "fuzzy",
"searchFields": [
"text"
]
},
"type": "NAME",
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"options": [
{
"value": "text",
"label": "text"
}
],
"searchCriteriaLabelPrefix": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"validations": [
{
"validator": null,
"message": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
],
"fieldId": "text",
"fieldType": "text"
}
]
}
],
"flags": [
{
"id": "text",
"requiresAction": true,
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
]
}
]post
Receive a notification of an action
Path parameters
eventTypestringRequired
actionTypestring · enumRequiredPossible values:
Body
Responses
200
200 OK
application/json
post
/trigger/events/{eventType}/actions/{actionType}POST /trigger/events/{eventType}/actions/{actionType} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 629
{
"event": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "text",
"createdAt": "2025-12-01T18:49:01.343Z",
"updatedAt": "2025-12-01T18:49:01.343Z",
"actions": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"transactionId": "text",
"createdByUserType": "user",
"createdAt": "2025-12-01T18:49:01.343Z",
"createdBy": "text",
"createdByRole": "text",
"createdBySignature": "text",
"createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
"declaration": {
"ANY_ADDITIONAL_PROPERTY": null
},
"annotation": {
"ANY_ADDITIONAL_PROPERTY": null
},
"status": "Requested",
"originalActionId": "123e4567-e89b-12d3-a456-426614174000",
"type": "text"
}
],
"trackingId": "text"
}
}200
200 OK
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "text",
"createdAt": "2025-12-01T18:49:01.343Z",
"updatedAt": "2025-12-01T18:49:01.343Z",
"actions": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"transactionId": "text",
"createdByUserType": "user",
"createdAt": "2025-12-01T18:49:01.343Z",
"createdBy": "text",
"createdByRole": "text",
"createdBySignature": "text",
"createdAtLocation": "123e4567-e89b-12d3-a456-426614174000",
"declaration": {
"ANY_ADDITIONAL_PROPERTY": null
},
"annotation": {
"ANY_ADDITIONAL_PROPERTY": null
},
"status": "Requested",
"originalActionId": "123e4567-e89b-12d3-a456-426614174000",
"type": "text"
}
],
"trackingId": "text"
}Last updated