Allowed Events
Configure which inbound events are routed to which destinations. Create allowed events, list them, change their destination membership, and delete them through the Ours Privacy REST API.
Use this page to manage the allow list that gates which inbound events are dispatched to which destinations.
Where this fits in the dispatch flow
Events flow through four stages on the way from a source to a destination:
Configuration changes at any stage take effect once you publish a new version.
Allowed Events is the first stage that can drop an event. An inbound event is matched against allowed events by name, case-insensitively. If no allowed event matches, the event is dropped and nothing downstream sees it. If a match is found, the event is routed only to the destinations listed in that allowed event's destinationIds. Everything that survives the allow-list stage then goes through Data Governance and the destination's Mappings before dispatch.
Naming rules
nameis trimmed when the allowed event is created. Inbound names are not trimmed, so they match only when they equal the stored name, ignoring case.- Names starting with
$are reserved for system events.$identifyis the one system event you can allow.
Adding and removing destinations
destinationIds is the second gate. An allowed event routes to exactly the destinations on its list, so a new destination receives an event once its ID is added to that event's list.
PATCH /rest/v1/allowed-events/{id} replaces destinationIds in full, so send every destination the event should keep.
Operational signals
To check that an allowed event reaches its destinations, call destination health for each ID in destinationIds. A zero successCount while the event is firing means it is dropped before dispatch, usually by Data Governance or a destination's Mappings.
GET/rest/v1/allowed-events
Ours Privacy API key
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/allowed-events"{ "entities": [ { "id": "string", "name": "string", "destinationIds": [ "string" ], "trigger": "string", "createdAt": "string", "updatedAt": "string" } ]}POST/rest/v1/allowed-events
Ours Privacy API key
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rest/v1/allowed-events" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "id": "string", "name": "string", "destinationIds": [ "string" ], "trigger": "string", "createdAt": "string", "updatedAt": "string"}GET/rest/v1/allowed-events/{id}
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rest/v1/allowed-events/string"{ "id": "string", "name": "string", "destinationIds": [ "string" ], "trigger": "string", "createdAt": "string", "updatedAt": "string"}PATCH/rest/v1/allowed-events/{id}
Ours Privacy API key
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/rest/v1/allowed-events/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "name": "string", "destinationIds": [ "string" ], "trigger": "string", "createdAt": "string", "updatedAt": "string"}DELETE/rest/v1/allowed-events/{id}
Ours Privacy API key
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/rest/v1/allowed-events/string"trueHow is this guide?

