Outpost API

​Deliveries

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

​List Deliveries (Admin)

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

​List Deliveries (Admin) › query Parameters

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

​List Deliveries (Admin) › Responses

    • modelsobject[]
    • paginationobject

​List Deliveries

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

​List Deliveries › path Parameters

  • tenant_idstring · required

​List Deliveries › query Parameters

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

​List Deliveries › Responses

    • modelsobject[]
    • paginationobject

​Get Delivery

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

​Get Delivery › path Parameters

  • tenant_idstring · required
  • delivery_idstring · required

​Get Delivery › query Parameters

  • include

​Get Delivery › Responses

    • idstring
    • statusstring · enum
      Enum values:
      success
      failed
    • delivered_atstring · date-time
    • codestring
    • response_dataobject
    • attemptinteger
    • manualboolean
    • event
    • destinationstring

​Retry Delivery

POST
http://localhost:3333/api/v1
/tenants/{tenant_id}/deliveries/{delivery_id}/retry

​Retry Delivery › path Parameters

  • tenant_idstring · required
  • delivery_idstring · required

​Retry Delivery › Responses

    No schema specified
TopicsEvents