Add custom timeline events

The Pismo platform generates many common timeline events. However, you may add custom events to meet your specific requirements.

To add a custom timeline event for an account, use the Add events endpoint. Simply specify the type, category, and any data for the timeline event that you want to add.

🚧

For the event ID it is necessary to concatenate TENANT::ACCOUNT::TIMESTAMP.

{
    "has_next": false,
    "next_cursor": null,
    "count": 3,
    "items": [
        {
            "type": "TYPE",
            "account_id": 100697199,
            "category": "CATEGORY",
            "tenant_account_timestamp": "TN-6aec613f-44ba-4184-9488-bf0343e74734::100697199::2022-02-02T17:01:34.751790540Z",
            "data": {
                "item": {
                    "item-7": "seven",
                    "item-6": 6,
                    "item-5": "five"
                }
            },
            "correlation_id": "03dbd18b-f714-4a44-b56d-fedf307bc1eb",
            "timestamp": "2022-02-02T17:01:34.751790540Z"
        },
        {
            "type": "TYPE",
            "account_id": 100697199,
            "category": "CATEGORY",
            "tenant_account_timestamp": "TN-6aec613f-44ba-4184-9488-bf0343e74734::100697199::2022-02-02T17:00:00.574360000Z",
            "data": {
                "item": {
                    "item-4": 4,
                    "item-3": "three"
                }
            },
            "correlation_id": "49ff2bcf-fcd3-4d83-99aa-97b088836f8f",
            "timestamp": "2022-02-02T17:00:00.574360000Z"
        },
        {
            "type": "TYPE",
            "account_id": 100697199,
            "category": "CATEGORY",
            "tenant_account_timestamp": "TN-6aec613f-44ba-4184-9488-bf0343e74734::100697199::2022-02-02T16:58:01.123450000Z",
            "data": {
                "item": {
                    "item-2": "two",
                    "item-1": 1
                }
            },
            "correlation_id": "eb55fc5c-4c4c-4fa0-9188-87388483b1ca",
            "timestamp": "2022-02-02T16:58:01.123450000Z"
        }
    ]
}

🚧

Important

You are responsible for the custom timeline events that you send to the Pismo platform. We recommend that you implement a retry mechanism and track the correlation_ID of any failed requests. (The correlation_ID field is used to link related API requests and events. For example, if you make an authorization request with 10 installments, this generates 1 event authorization event and 10 transaction events, all containing the same correlation ID.) If an error occurs, this data will enable us to help you resolve the issue.