> ## Documentation Index > Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Track an event > Records an inbound event that can trigger a journey. Requires an event name, a messageId you generate, a type, and a properties object. ## OpenAPI ````yaml /openapi-specs/openapi.documented.yml post /inbound/courier openapi: 3.0.1 info: title: Courier description: The Courier REST API for sending and managing notifications across channels. version: 0.0.1 servers: - url: https://api.courier.com description: Production security: [] tags: - name: Send description: >- Send a message to one or more recipients — users, lists, audiences, or tenants — across every channel you have configured. - name: Templates description: >- Create, update, version, publish, and localize notification templates and their content. - name: Brands description: >- Manage the logos, colors, and layout that give the templates you send a consistent look. - name: Routing Strategies description: >- Define reusable channel routing and failover strategies, and see which templates use them. - name: Journeys description: >- Build, version, publish, invoke, and cancel multi-step notification workflows, along with the templates scoped to them. - name: Broadcasts description: >- Create a one-off send to a list or audience, author its content, then send it immediately or schedule it for later. - name: User Profiles description: >- Store the contact information Courier delivers to for each user — email, phone number, push tokens, and any custom data you send to. - name: Tenants description: >- Manage tenants — the organizations, teams, or accounts your users belong to — along with their users and default preferences. - name: Audiences description: >- Define filter-based groups whose membership Courier recalculates as user profiles change. - name: Lists description: >- Manage static groups of users that you subscribe explicitly, and send to them by list id or list pattern. - name: Providers description: >- Configure the channel providers Courier delivers through, and browse the provider types it supports. - name: Preference Topics description: >- Manage the workspace catalog of subscription topics, the sections that group them, and publishing the preference page. - name: User Preferences description: >- Read and write a single user's notification preferences, per topic and per channel. - name: Messages description: >- Look up the messages Courier has accepted, inspect their delivery history and rendered output, and cancel, resend, or archive them. - name: Device Tokens description: >- Register and manage the APNS and FCM device tokens Courier delivers push notifications to. - name: Tenant Memberships description: >- Associate a user with one or more tenants, and read or remove those associations. - name: Tenant Templates description: >- Manage the templates and template versions scoped to a single tenant, including the ones authored in the embedded designer. - name: Automations description: >- Invoke a stored automation template or an ad hoc automation defined in the request. - name: Digests description: >- Inspect what has accumulated in a digest schedule and release a digest ahead of its next scheduled delivery. - name: Translations description: >- Store and retrieve the translation strings Courier uses to render localized template content. - name: Inbox description: Manage the messages in a user's in-app inbox. - name: Track Events description: >- Record an inbound event that triggers the journeys and automations mapped to it. - name: Audit Events description: >- Read the audit trail of configuration and access changes in your workspace. - name: Authentication description: >- Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the embedded designer — can call Courier as a single user. Server-side requests authenticate with your workspace API key instead. paths: /inbound/courier: post: tags: - Track Events summary: Track an event description: >- Records an inbound event that can trigger a journey. Requires an event name, a messageId you generate, a type, and a properties object. operationId: inbound_track parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InboundTrackEvent' examples: Example1: value: event: New Order Placed messageId: 4c62c457-b329-4bea-9bfc-17bba86c393f userId: '1234' type: track properties: order_id: 123 total_orders: 5 last_order_id: 122 responses: '202': description: '' content: application/json: schema: $ref: '#/components/schemas/TrackAcceptedResponse' examples: Example1: value: messageId: 1-6952feeb-7fed6092da5363f2af38eb42 '400': description: '' content: application/json: schema: $ref: '#/components/schemas/BadRequest' examples: Example: value: message: Example message text type: invalid_request_error '409': description: '' content: application/json: schema: $ref: '#/components/schemas/Conflict' examples: Example: value: message: Example message text type: invalid_request_error security: - BearerAuth: [] x-codeSamples: - lang: JavaScript source: |- import Courier from '@trycourier/courier'; const client = new Courier({ apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted }); const response = await client.inbound.trackEvent({ event: 'New Order Placed', messageId: '4c62c457-b329-4bea-9bfc-17bba86c393f', properties: { order_id: 123, total_orders: 5, last_order_id: 122, }, type: 'track', userId: '1234', }); console.log(response.messageId); - lang: Python source: |- import os from courier import Courier client = Courier( api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted ) response = client.inbound.track_event( event="New Order Placed", message_id="4c62c457-b329-4bea-9bfc-17bba86c393f", properties={ "order_id": 123, "total_orders": 5, "last_order_id": 122, }, type="track", user_id="1234", ) print(response.message_id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/trycourier/courier-go\"\n\t\"github.com/trycourier/courier-go/option\"\n)\n\nfunc main() {\n\tclient := courier.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Inbound.TrackEvent(context.TODO(), courier.InboundTrackEventParams{\n\t\tEvent: \"New Order Placed\",\n\t\tMessageID: \"4c62c457-b329-4bea-9bfc-17bba86c393f\",\n\t\tProperties: map[string]any{\n\t\t\t\"order_id\": 123,\n\t\t\t\"total_orders\": 5,\n\t\t\t\"last_order_id\": 122,\n\t\t},\n\t\tType: courier.InboundTrackEventParamsTypeTrack,\n\t\tUserID: courier.String(\"1234\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.MessageID)\n}\n" - lang: Java source: |- package com.courier.example; import com.courier.client.CourierClient; import com.courier.client.okhttp.CourierOkHttpClient; import com.courier.core.JsonValue; import com.courier.models.inbound.InboundTrackEventParams; import com.courier.models.inbound.InboundTrackEventResponse; public final class Main { private Main() {} public static void main(String[] args) { CourierClient client = CourierOkHttpClient.fromEnv(); InboundTrackEventParams params = InboundTrackEventParams.builder() .event("New Order Placed") .messageId("4c62c457-b329-4bea-9bfc-17bba86c393f") .properties(InboundTrackEventParams.Properties.builder() .putAdditionalProperty("order_id", JsonValue.from("bar")) .putAdditionalProperty("total_orders", JsonValue.from("bar")) .putAdditionalProperty("last_order_id", JsonValue.from("bar")) .build()) .type(InboundTrackEventParams.Type.TRACK) .build(); InboundTrackEventResponse response = client.inbound().trackEvent(params); } } - lang: Ruby source: |- require "courier" courier = Courier::Client.new(api_key: "My API Key") response = courier.inbound.track_event( event: "New Order Placed", message_id: "4c62c457-b329-4bea-9bfc-17bba86c393f", properties: {order_id: "bar", total_orders: "bar", last_order_id: "bar"}, type: :track ) puts(response) - lang: PHP source: >- inbound->trackEvent( event: 'New Order Placed', messageID: '4c62c457-b329-4bea-9bfc-17bba86c393f', properties: [ 'order_id' => 'bar', 'total_orders' => 'bar', 'last_order_id' => 'bar' ], type: 'track', userID: '1234', ); var_dump($response); } catch (APIException $e) { echo $e->getMessage(); } - lang: C# source: |- using System; using System.Collections.Generic; using System.Text.Json; using TryCourier; using Inbound = TryCourier.Models.Inbound; CourierClient client = new(); Inbound::InboundTrackEventParams parameters = new() { Event = "New Order Placed", MessageID = "4c62c457-b329-4bea-9bfc-17bba86c393f", Properties = new Dictionary() { { "order_id", JsonSerializer.SerializeToElement("bar") }, { "total_orders", JsonSerializer.SerializeToElement("bar") }, { "last_order_id", JsonSerializer.SerializeToElement("bar") }, }, Type = Inbound::Type.Track, }; var response = await client.Inbound.TrackEvent(parameters); Console.WriteLine(response); - lang: CLI source: |- courier inbound track-event \ --api-key 'My API Key' \ --event 'New Order Placed' \ --message-id 4c62c457-b329-4bea-9bfc-17bba86c393f \ --properties '{order_id: bar, total_orders: bar, last_order_id: bar}' \ --type track components: schemas: InboundTrackEvent: title: InboundTrackEvent type: object properties: event: type: string description: >- A descriptive name of the event. This name will appear as a trigger in the Courier Automation Trigger node. example: New Order Placed messageId: type: string description: >- A required unique identifier that will be used to de-duplicate requests. If not unique, will respond with 409 Conflict status example: 4c62c457-b329-4bea-9bfc-17bba86c393f properties: type: object additionalProperties: true type: type: string enum: - track userId: type: string nullable: true description: The user id associated with the track required: - event - messageId - properties - type TrackAcceptedResponse: title: TrackAcceptedResponse type: object properties: messageId: type: string description: >- A successful call returns a `202` status code along with a `requestId` in the response body. example: 1-65f240a0-47a6a120c8374de9bcf9f22c required: - messageId BadRequest: title: BadRequest type: object properties: type: type: string enum: - invalid_request_error required: - type allOf: - $ref: '#/components/schemas/BaseError' Conflict: title: Conflict type: object properties: type: type: string enum: - invalid_request_error required: - type allOf: - $ref: '#/components/schemas/BaseError' BaseError: title: BaseError type: object properties: message: type: string description: A message describing the error that occurred. required: - message securitySchemes: BearerAuth: type: http scheme: bearer ````