---
updatedAt: 2026-05-22T15:57:54.000Z
agentTools:
projectIndex: https://docs.ometria.com/llms.txt
---
# Returns a specific custom event
Returns a specific custom event
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"version": "1.1.0",
"title": "Ometria data API",
"description": "Welcome to the Ometria API reference.\n\n\nThe Ometria API is organized around the [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an API key which can be obtained from your account settings.\n\n### HTTPS\n\nAll requests to the Ometria API MUST be carried out via HTTPS. API servers do not listen on unsecured HTTP ports to avoid the possibility of insecure information exchange.\n\n### Message encoding\n\nThe V2 Ometria API uses JSON encoding for all data exchanges and assumes UTF-8 character encoding throughout.\n\n### Rate limits\n\nThe Ometria API has a default rate limit of 4 requests per second per Ometria account. The /push/ endpoint allows 8 requests per second per Ometria account. If you expect to exceed this limit, please contact us.\n\nIn the case of your application being rate limited, the HTTP code 429 (too many requests) will be returned. In this case your application should reduce the number of requests it is trying to send.",
"contact": {
"name": "Ometria",
"email": "support@ometria.com",
"url": "https://ometria.com"
}
},
"x-explorer-enabled": false,
"paths": {
"/custom-events/{event_type}/{event_id}": {
"get": {
"tags": [
"Custom Event"
],
"summary": "Returns a specific custom event",
"description": "Returns a specific custom event",
"parameters": [
{
"name": "event_type",
"in": "path",
"description": "The event type. This must be pre-defined in Ometria and the value here should match that the type in Ometria.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "event_id",
"in": "path",
"description": "The event ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "A single custom event object",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomEvent"
}
}
}
},
"403": {
"description": "API key is not authorised to access this resource"
},
"404": {
"description": "The specific custom event could not be found"
}
}
}
}
},
"security": [
{
"apikey": []
}
],
"servers": [
{
"url": "https://api.ometria.com/v2"
}
],
"components": {
"securitySchemes": {
"apikey": {
"type": "apiKey",
"name": "X-Ometria-Auth",
"in": "header",
"description": "Ometria API key which can be obtained from your Ometria account administrator"
}
},
"schemas": {
"ExtraIdentifier": {
"title": "Extra Identifier",
"type": "object",
"description": "An additional identifier for a record, used to attach non-standard customer or record IDs (e.g. loyalty programme IDs, external CRM IDs). Records may carry multiple extra identifiers.",
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "string",
"description": "The identifier type label. Must contain only lowercase letters and underscores (regex `^[a-z_]+$`), 1-255 characters. Will be coerced to lowercase on ingestion.",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-z_]+$",
"example": "loyalty_id"
},
"value": {
"type": "string",
"description": "The identifier value (free-form string).",
"example": "LOY-7898734"
}
},
"example": {
"type": "loyalty_id",
"value": "LOY-7898734"
}
},
"CustomEvent": {
"title": "Custom Event",
"type": "object",
"description": "Describes a custom event. One of \"profile_id\", \"identity_email\", \"identity_account_id\" or \"extra_identifiers\" is required.",
"required": [
"@type",
"id",
"event_type",
"timestamp",
"properties"
],
"properties": {
"@type": {
"type": "string",
"description": "The value must be \"custom_event\". This shows that this record represents a custom_event object."
},
"id": {
"type": "string",
"description": "The custom event ID, max length: 32.\nIf you exceed the character limit the field will pass validation but appear truncated in Ometria."
},
"event_type": {
"type": "string",
"description": "The custom_event type, maximum characters 64.\nIf you exceed the character limit the field will pass validation but appear truncated in Ometria."
},
"timestamp": {
"type": "string",
"description": "The date and time of the event, following ISO 8601 DateTime format with timezone offset YYYY-MM-DDThh:mm:ss+Z."
},
"properties": {
"$ref": "#/components/schemas/CustomEventProperties"
},
"profile_id": {
"type": "string",
"description": "The profile ID of the contact on which to trigger this custom event."
},
"identity_email": {
"type": "string",
"description": "The email of the contact record on which to trigger this custom event, max length: 255, lower case.\nIf left empty this field will be set to 'null'."
},
"identity_phone_number": {
"type": "string",
"description": "The phone_number of the contact record on which to trigger this custom event, in E.164/International format (e.g. starting \"+447...\").\nIf left empty this field will be set to 'null'."
},
"identity_account_id": {
"type": "string",
"description": "The contact ID of the contact record on which to trigger this custom event."
},
"extra_identifiers": {
"type": "array",
"description": "Optional list of extra identifiers (such as a loyalty ID) as per your identity resolution configuration, e.g. `loyalty_id`. Custom identifiers must be configured for your account before you send them. See Custom identifiers for the full format, multi-valued identifiers, and CSV usage.",
"nullable": true,
"items": {
"$ref": "#/components/schemas/ExtraIdentifier"
}
}
},
"example": {
"@type": "custom_event",
"id": "xxxxxx",
"event_type": "module_interaction",
"timestamp": "2017-05-01T14:00:00Z",
"properties": {
"interaction": "saved_to_favs"
},
"profile_id": "xxxxx",
"identity_email": "",
"identity_phone_number": "+447812123456",
"identity_account_id": "",
"extra_identifiers": [
{
"type": "loyalty_id",
"value": "LOY-7898734"
},
{
"type": "external_id",
"value": "crm-abc-123"
}
]
}
},
"CustomEventProperties": {
"type": "object",
"description": "These are the custom fields you need to add for your custom event. There are 5 types available for custom event fields: string, boolean, number, products list and date.",
"properties": {
"string_custom_field": {
"type": "string",
"description": "Any characters permitted, including accents and other character symbols.\nString fields have a 512 character limit."
},
"boolean_custom_field": {
"type": "boolean",
"description": "`true` or `false`"
},
"number_custom_field": {
"type": "number",
"description": "Whole or decimal numbers"
},
"products_list_custom_field": {
"type": "array",
"description": "Returns a list of your products",
"items": {
"type": "string"
}
},
"date_custom_field": {
"type": "string",
"description": "Date and time, e.g. 2018-01-05 15:03:04",
"format": "date"
}
}
}
}
},
"x-readme": {
"proxy-enabled": true,
"samples-enabled": true
}
}
```