--- updatedAt: 2025-02-19T23:45:05.000Z agentTools: projectIndex: https://documentation.safecube.ai/llms.txt --- # Send Event Type Example Message Send an example message for a specific event. Note that this will only sent demo data (and not real tracking data) This can only be used to send event types that are configured for the endpoint. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Webhook api", "version": "1.2.1", "description": "Welcome to the documentation of Webhook API\n

Compatibility guidelines

The HTTP API is versioned with a single number, which is currently 1

This number symbolizes the major version number. New features can be added to the API in the same version number if there is no breaking change.

The version number is present in the url, for instance /webhook/api/v1 for the current version.

Please notice that all \"/shipment\" endpoints are deprecated. Therefore it is recommended to use the \"/easy-shipment\" endpoints.

\n

Documentation, Pricing and Key generation

You can find the complete documentation for our API at Developers Platform.

Create an account to receive your FREE key in under a minute!

Additionally, explore our pricing plans, access support, view detailed documentation, and follow our comprehensive tutorials.

\n

Authentication

Every endpoints of this API require authentication using an API key.

If you don't have an API Key and you need to use the Ports and Vessels API, you need to ask Sinay to have one.

To use the API Key, you must add a header named API_KEY with your API Key as a value.

Test the API with Swagger-ui

To test the API using Swagger-ui, you must click on the button Authorize and then fill the apiKey field and click on Authorize.

Swagger-ui will then use the api key automatically in each request.

On every endpoints, you can click on Try it out, you can modify the body and then click on Execute

You will be able to see the response.

\n

Release note

1.2.0

1.1.0

1.0.0

" }, "servers": [ { "url": "https://api.sinay.ai/webhook/api/v1" } ], "security": [ { "ApiKey": [] } ], "tags": [ { "name": "Endpoint", "description": "Endpoints are the URLs messages will be sent to. Endpoints must be configured with filters to setup which events you wish to track with them." } ], "paths": { "/endpoint/{endpoint_id}/send-example": { "post": { "tags": [ "Endpoint" ], "summary": "Send Event Type Example Message", "description": "Send an example message for a specific event. Note that this will only sent demo data (and not real tracking data) This can only be used to send event types that are configured for the endpoint.", "operationId": "v1.endpoint.send-example", "parameters": [ { "in": "path", "name": "endpoint_id", "description": "The ep's ID or UID", "required": true, "schema": { "description": "The ep's ID or UID To retrieve your endpoints ids, use GET /endpoint.", "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "example": "unique-ep-identifier" }, "style": "simple" }, { "in": "header", "name": "idempotency-key", "description": "The request's idempotency key", "schema": { "type": "string" }, "style": "simple" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventExampleIn" } } }, "required": true }, "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageOut" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpErrorOut" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpErrorOut" } } } }, "404": { "description": "Not Found. Endpoint not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpErrorOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpErrorOut" } } } }, "500": { "description": "Internal Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpErrorOut" } } } } } } } }, "components": { "schemas": { "HttpErrorOut": { "title": "HttpError", "type": "object", "required": [ "code", "detail" ], "properties": { "code": { "type": "string" }, "detail": { "type": "string" } } }, "HTTPValidationError": { "type": "object", "required": [ "detail" ], "properties": { "detail": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "ValidationError": { "description": "Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.", "type": "object", "required": [ "loc", "msg", "type" ], "properties": { "loc": { "description": "The location as a [`Vec`] of [`String`]s -- often in the form `[\"body\", \"field_name\"]`, `[\"query\", \"field_name\"]`, etc. They may, however, be arbitrarily deep.", "type": "array", "items": { "type": "string" } }, "msg": { "description": "The message accompanying the validation error item.", "type": "string" }, "type": { "description": "The type of error, often \"type_error\" or \"value_error\", but sometimes with more context like as \"value_error.number.not_ge\"", "type": "string" } } }, "EventExampleIn": { "type": "object", "required": [ "eventType" ], "properties": { "eventType": { "description": "The event type's name", "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$", "example": [ "shipment.added.to.endpoint", "container.new.event.detected" ] } } }, "MessageOut": { "type": "object", "required": [ "eventType", "id", "payload", "timestamp" ], "properties": { "eventId": { "description": "Optional unique identifier for the message", "type": "string", "maxLength": 256, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-_.]+$", "example": "unique-msg-identifier", "nullable": true }, "eventType": { "description": "The event type's name", "type": "string", "maxLength": 256, "pattern": "^[a-zA-Z0-9\\-_.]+$" }, "payload": { "type": "object", "example": { "email": "test@example.com", "type": "user.created", "username": "test_user" } }, "channels": { "description": "List of free-form identifiers that endpoints can filter by", "type": "array", "items": { "type": "string", "maxLength": 128, "pattern": "^[a-zA-Z0-9\\-_.]+$", "example": "project_1337" }, "maxItems": 5, "minItems": 1, "uniqueItems": true, "nullable": true, "example": [ "project_123", "group_2" ] }, "id": { "description": "The msg's ID", "type": "string", "example": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2" }, "timestamp": { "type": "string", "format": "date-time" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "API_KEY" } } } } ```