Outpost API

​Attempts

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

​List Attempts (Admin)

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

​List Attempts (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 Attempts (Admin) › Responses

    • modelsobject[]
    • paginationobject

​List Attempts

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

​List Attempts › path Parameters

  • tenant_idstring · required

​List Attempts › 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 Attempts › Responses

    • modelsobject[]
    • paginationobject

​Get Attempt

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

​Get Attempt › path Parameters

  • tenant_idstring · required
  • attempt_idstring · required

​Get Attempt › query Parameters

  • include

​Get Attempt › Responses

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

​Retry Attempt

POST
http://localhost:3333/api/v1
/tenants/{tenant_id}/attempts/{attempt_id}/retry

​Retry Attempt › path Parameters

  • tenant_idstring · required
  • attempt_idstring · required

​Retry Attempt › Responses

    No schema specified
TopicsEvents