Outpost API

​Events

Endpoint:http://localhost:3333/api/v1

Operations related to event history and deliveries.

​List Events

GET
http://localhost:3333/api/v1
/{tenant_id}/events

Retrieves a list of events for the tenant, supporting cursor navigation (details TBD) and filtering.

​List Events › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

​List Events › query Parameters

  • destination_id

    Filter events by destination ID(s).

  • statusstring · enum

    Filter events by delivery status.

    Enum values:
    success
    failed

​List Events › Responses

    object[]
    • idstring
    • destination_idstring
    • topicstring
    • timestring · date-time

      Time the event was received/processed.

    • successful_atstring · date-time

      Time the event was successfully delivered.

    • metadataobject

      Key-value string pairs of metadata associated with the event.

    • dataobject

      Freeform JSON data of the event.

​Get Event

GET
http://localhost:3333/api/v1
/{tenant_id}/events/{event_id}

Retrieves details for a specific event.

​Get Event › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

  • event_idstring · required

    The ID of the event.

​Get Event › Responses

    • idstring
    • destination_idstring
    • topicstring
    • timestring · date-time

      Time the event was received/processed.

    • successful_atstring · date-time

      Time the event was successfully delivered.

    • metadataobject

      Key-value string pairs of metadata associated with the event.

    • dataobject

      Freeform JSON data of the event.

​List Event Delivery Attempts

GET
http://localhost:3333/api/v1
/{tenant_id}/events/{event_id}/deliveries

Retrieves a list of delivery attempts for a specific event, including response details.

​List Event Delivery Attempts › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

  • event_idstring · required

    The ID of the event.

​List Event Delivery Attempts › Responses

    object[]
    • delivered_atstring · date-time
    • statusstring · enum
      Enum values:
      success
      failed
    • response_status_codeinteger
    • response_bodystring
    • response_headersobject

​List Events by Destination

GET
http://localhost:3333/api/v1
/{tenant_id}/destinations/{destination_id}/events

Retrieves events associated with a specific destination for the tenant.

​List Events by Destination › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

  • destination_idstring · required

    The ID of the destination.

​List Events by Destination › query Parameters

  • statusstring · enum

    Filter events by delivery status.

    Enum values:
    success
    failed

​List Events by Destination › Responses

    object[]
    • idstring
    • destination_idstring
    • topicstring
    • timestring · date-time

      Time the event was received/processed.

    • successful_atstring · date-time

      Time the event was successfully delivered.

    • metadataobject

      Key-value string pairs of metadata associated with the event.

    • dataobject

      Freeform JSON data of the event.

​Get Event by Destination

GET
http://localhost:3333/api/v1
/{tenant_id}/destinations/{destination_id}/events/{event_id}

Retrieves a specific event associated with a specific destination for the tenant.

​Get Event by Destination › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

  • destination_idstring · required

    The ID of the destination.

  • event_idstring · required

    The ID of the event.

​Get Event by Destination › Responses

    • idstring
    • destination_idstring
    • topicstring
    • timestring · date-time

      Time the event was received/processed.

    • successful_atstring · date-time

      Time the event was successfully delivered.

    • metadataobject

      Key-value string pairs of metadata associated with the event.

    • dataobject

      Freeform JSON data of the event.

​Retry Event Delivery

POST
http://localhost:3333/api/v1
/{tenant_id}/destinations/{destination_id}/events/{event_id}/retry

Triggers a retry for a failed event delivery.

​Retry Event Delivery › path Parameters

  • tenant_idstring · required

    The ID of the tenant. Required when using AdminApiKey authentication.

  • destination_idstring · required

    The ID of the destination.

  • event_idstring · required

    The ID of the event to retry.

​Retry Event Delivery › Responses

    No schema specified
TopicsOther endpoints