Outpost API

​Events

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

​List Events (Admin)

GET
http://localhost:3333/api/v1
/events

​List Events (Admin) › query Parameters

  • tenant_idstring
  • destination_idstring
  • topic
  • time[gte]string · date-time
  • time[lte]string · date-time
  • limitinteger · min: 1 · max: 1000
    Default: 100
  • nextstring
  • prevstring
  • order_bystring · enum
    Enum values:
    time
    Default: time
  • dirstring · enum
    Enum values:
    asc
    desc
    Default: desc

​List Events (Admin) › Responses

    • modelsobject[]
    • paginationobject

​List Events

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

​List Events › path Parameters

  • tenant_idstring · required

​List Events › query Parameters

  • destination_id
  • statusstring · enum
    Enum values:
    success
    failed
  • nextstring
  • prevstring
  • limitinteger · min: 1 · max: 1000
    Default: 100
  • time[gte]string · date-time
  • time[lte]string · date-time
  • order_bystring · enum
    Enum values:
    time
    Default: time
  • dirstring · enum
    Enum values:
    asc
    desc
    Default: desc

​List Events › Responses

    • modelsobject[]
    • paginationobject

​Get Event

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

​Get Event › path Parameters

  • tenant_idstring · required
  • event_idstring · required

​Get Event › Responses

    • idstring
    • destination_idstring
    • topicstring
    • timestring · date-time
    • successful_atstring · date-time
    • metadataobject
    • statusstring · enum
      Enum values:
      success
      failed
    • dataobject

​List Event Delivery Attempts

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

​List Event Delivery Attempts › path Parameters

  • tenant_idstring · required
  • event_idstring · required

​List Event Delivery Attempts › Responses

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

​List Events by Destination

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

​List Events by Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​List Events by Destination › query Parameters

  • statusstring · enum
    Enum values:
    success
    failed
  • nextstring
  • prevstring
  • limitinteger · min: 1 · max: 1000
    Default: 100
  • time[gte]string · date-time
  • time[lte]string · date-time
  • order_bystring · enum
    Enum values:
    time
    Default: time
  • dirstring · enum
    Enum values:
    asc
    desc
    Default: desc

​List Events by Destination › Responses

    • modelsobject[]
    • paginationobject
deprecated

​Get Event by Destination

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

​Get Event by Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required
  • event_idstring · required

​Get Event by Destination › Responses

    • idstring
    • destination_idstring
    • topicstring
    • timestring · date-time
    • successful_atstring · date-time
    • metadataobject
    • statusstring · enum
      Enum values:
      success
      failed
    • dataobject
deprecated

​Retry Event Delivery

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

​Retry Event Delivery › path Parameters

  • tenant_idstring · required
  • destination_idstring · required
  • event_idstring · required

​Retry Event Delivery › Responses

    No schema specified
DeliveriesOther endpoints