Events
get
Get event configurations
Responses
200
200 OK
application/json
Configuration defining an event type registered in OpenCRVS (for example birth or death).
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 core and custom actions associated with the event.
or
or
or
or
or
or
or
or
or
or
or
or
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.
analyticsbooleanRequiredDefault:
Indicates whether the records of this event type are included in analytics
trueget/config/events
GET /config/events HTTP/1.1
Accept: */*
200
200 OK
[
{
"id": "text",
"dateOfEvent": {
"$$field": "text",
"$$subfield": [
"text"
],
"$$code": "text"
},
"placeOfEvent": {
"$$field": "text",
"$$subfield": [
"text"
],
"$$code": "text"
},
"title": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"fallbackTitle": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"summary": {
"banners": [
{
"type": "info",
"background": "tinted",
"icon": "Archived",
"heading": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"description": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"conditionals": [
{
"type": "text",
"conditional": null
}
]
}
],
"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": null,
"supportingCopy": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"icon": "text",
"conditionals": null,
"type": "text",
"review": {
"title": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"fields": [
"[Circular Reference]"
]
}
}
],
"actionOrder": [
"text"
],
"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",
"conditionals": [
{
"type": "text",
"conditional": null
}
]
}
],
"searchCriteriaLabelPrefix": {
"id": "text",
"defaultMessage": "text",
"description": "text"
},
"conditionals": [
{
"type": "text",
"conditional": null
}
],
"validations": [
{
"validator": null,
"message": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
],
"allowedLocations": {
"$jurisdiction": "administrativeArea"
},
"fieldId": "text",
"fieldType": "text"
}
]
}
],
"flags": [
{
"id": "text",
"requiresAction": true,
"label": {
"id": "text",
"defaultMessage": "text",
"description": "text"
}
}
],
"analytics": true,
"icon": {
"ANY_ADDITIONAL_PROPERTY": null
}
}
]post
Receive a notification of an action
Path parameters
eventTypestringRequired
actionTypestring · enumRequiredPossible values:
Body
Responses
200
200 OK
application/json
idstring · uuidRequiredPattern:
Unique identifier of the event.
^([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-timeRequiredPattern:
Timestamp indicating when the event was created.
^(?:(?:\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-timeRequiredPattern:
Timestamp of the last update, excluding changes from actions.
^(?:(?:\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}
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-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"actions": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"transactionId": "text",
"createdByUserType": "user",
"createdAt": "2026-01-01T00:00:00.000Z",
"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-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"actions": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"transactionId": "text",
"createdByUserType": "user",
"createdAt": "2026-01-01T00:00:00.000Z",
"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