Events

get

Get event configurations

Responses

200

200 OK

application/json

Configuration defining an event type.

idstringRequired

Machine-readable identifier of the event (e.g. "birth", "death").

dateOfEventany ofOptional

Reference to the field capturing the date of the event (e.g. date of birth). Defaults to the event creation date if unspecified.

or

actionsone of[]Required

Configuration of system-defined actions associated with the event.

or

or

or

or

or

or

or

or

actionOrderstring[]Optional

Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions.

get

/events

HTTPcURLJavaScriptPython

GET /events HTTP/1.1
Accept: */*

200

200 OK

[
  {
    "id": "text",
    "dateOfEvent": {
      "$$field": "text",
      "$$subfield": [
        "text"
      ]
    },
    "placeOfEvent": {
      "$$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
          }
        ],
        "supportingCopy": {
          "id": "text",
          "defaultMessage": "text",
          "description": "text"
        },
        "icon": "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"
                      ]
                    }
                  }
                ],
                "allowedLocations": {
                  "$jurisdiction": "administrativeArea"
                }
              },
              "defaultValue": {
                "country": "text",
                "streetLevelDetails": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "addressType": "text",
                "administrativeArea": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ]
        }
      }
    ],
    "actionOrder": [
      "text"
    ],
    "declaration": {
      "label": {
        "id": "text",
        "defaultMessage": "text",
        "description": "text"
      },
      "pages": [
        {
          "id": "text",
          "title": {
            "id": "text",
            "defaultMessage": "text",
            "description": "text"
          },
          "requireCompletionToContinue": false,
          "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"
                      ]
                    }
                  }
                ],
                "allowedLocations": {
                  "$jurisdiction": "administrativeArea"
                }
              },
              "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

application/json

Responses

200

200 OK

application/json

idstring · uuidRequired

Unique identifier of the event.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

typestringRequired

Type of the event (e.g. birth, death, marriage).

createdAtstring · date-timeRequired

Timestamp indicating when the event was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAtstring · date-timeRequired

Timestamp of the last update, excluding changes from actions.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

trackingIdstringRequired

System-generated tracking identifier used to look up the event.

post

/trigger/events/{eventType}/actions/{actionType}

HTTPcURLJavaScriptPython

POST /trigger/events/{eventType}/actions/{actionType} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 629

{
  "event": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "text",
    "createdAt": "2026-03-17T14:33:32.197Z",
    "updatedAt": "2026-03-17T14:33:32.197Z",
    "actions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "transactionId": "text",
        "createdByUserType": "user",
        "createdAt": "2026-03-17T14:33:32.197Z",
        "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": "2026-03-17T14:33:32.197Z",
  "updatedAt": "2026-03-17T14:33:32.197Z",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "transactionId": "text",
      "createdByUserType": "user",
      "createdAt": "2026-03-17T14:33:32.197Z",
      "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"
}