Skip to main content
POST
/
policies
/
{policyId}
/
events
Push policy custom event.
curl --request POST \
  --url https://api.example.com/policies/{policyId}/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventType": "<string>",
  "metadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "data": {}
}
'
{}

Path Parameters

policyId
string
required

the policy id

Query Parameters

whenAt
string

Optional: the whenAt datetime

branchId
string

Optional: the branch id

Body

application/json
eventType
string
required

The event type

metadata
object[]

metadata assigned to the object

data
object

The event data

Response

The response is of type object.