---
updatedAt: 2026-05-27T11:57:12.000Z
agentTools:
  projectIndex: https://developers.opentrack.co/llms.txt
---

# Get Webhook Events

This endpoint allows you to playback all the webhook event messages sent to your account endpoint(s).

The response looks as follows:

```json
{
total: 1
data: [{
    "event": "container.status.updated"
    "sentAt": "2025-05-27T07:42:32.950Z"
    "data": {...},
    "changes":
    {
      "status": { "previous": "DISCHARGED", "current": "AVAILABLE" }
    },
 }]
}
```

# OpenAPI definition

````json
{
  "openapi": "3.0.0",
  "servers": [
    {
      "description": "Production",
      "url": "https://api.opentrack.co"
    }
  ],
  "info": {
    "version": "v1",
    "title": "OpenTrack API",
    "contact": {
      "email": "support@opentrack.co"
    },
    "x-logo": {
      "url": "https://s3-us-west-1.amazonaws.com/opentrack.co/images/opentrack_logo_dark.png",
      "altText": "OpenTrack Logo"
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/v1/events": {
      "get": {
        "summary": "Get Webhook Events",
        "description": "This endpoint allows you to playback all the webhook event messages sent to your account endpoint(s).\n\nThe response looks as follows:\n\n```json\n{\ntotal: 1\ndata: [{\n    \"event\": \"container.status.updated\"\n    \"sentAt\": \"2025-05-27T07:42:32.950Z\"\n    \"data\": {...},\n    \"changes\":\n    {\n      \"status\": { \"previous\": \"DISCHARGED\", \"current\": \"AVAILABLE\" }\n    },\n }]\n}\n```",
        "operationId": "getEvents",
        "tags": [
          "/events"
        ],
        "parameters": [
          {
            "name": "timestamp",
            "in": "query",
            "required": true,
            "description": "Unix timestamp designating the start of the playback time range",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "events",
            "in": "query",
            "description": "The list of events to show",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "container.status.updated",
                  "container.history.updated",
                  "container.itinerary.updated",
                  "container.holds.updated",
                  "container.demurrage.updated",
                  "container.location.updated"
                ]
              }
            }
          },
          {
            "name": "containerId",
            "in": "query",
            "description": "The id of a container for which the related events are to be shown.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "The page of the result with events.",
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "perPage",
            "in": "query",
            "required": false,
            "description": "The number of events to be returned in a single request. Current limit is 25.",
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "events returned",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "total": {
                      "type": "number",
                      "example": 14
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/WebhookEvent"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "name": "Opentrack-API-Key",
        "in": "header"
      }
    },
    "schemas": {
      "WebhookEvent": {
        "type": "object",
        "properties": {
          "event": {
            "type": "string",
            "description": "Event name, e.g. container.status.updated"
          },
          "data": {
            "type": "object",
            "description": "Data representing the current state of the event entity at the time of the event"
          },
          "changes": {
            "type": "object",
            "description": "information about changes, e.g. voyageNumber: { current: '221A', previous: 'XA221A' }"
          },
          "sentAt": {
            "type": "string",
            "description": "Timestamp when the event has been sent."
          }
        }
      }
    }
  }
}
````