Outpost API

​Destinations

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

​List Destinations

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

​List Destinations › path Parameters

  • tenant_idstring · required

​List Destinations › query Parameters

  • type
  • topics

​List Destinations › Responses

    • idstring · required
    • typestring · enum · required
      Enum values:
      webhook
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_sqs
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      rabbitmq
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      hookdeck
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • config
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_kinesis
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      azure_servicebus
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_s3
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      gcp_pubsub
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly

​Create Destination

POST
http://localhost:3333/api/v1
/tenants/{tenant_id}/destinations

​Create Destination › path Parameters

  • tenant_idstring · required

​Create Destination › Request Body

  • typestring · enum · required
    Enum values:
    webhook
  • topicsrequired
  • configobject · required
  • idstring
  • filterobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    aws_sqs
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • filterobject
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    rabbitmq
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • filterobject
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    hookdeck
  • topicsrequired
  • credentialsobject · required
  • idstring
  • filterobject
  • config
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    aws_kinesis
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • filterobject
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    azure_servicebus
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • filterobject
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    aws_s3
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • filterobject
  • delivery_metadataobject
  • metadataobject
  • typestring · enum · required
    Enum values:
    gcp_pubsub
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • filterobject
  • delivery_metadataobject
  • metadataobject

​Create Destination › Responses

    • idstring · required
    • typestring · enum · required
      Enum values:
      webhook
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_sqs
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      rabbitmq
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      hookdeck
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • config
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_kinesis
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      azure_servicebus
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_s3
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      gcp_pubsub
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly

​Get Destination

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

​Get Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​Get Destination › Responses

    • idstring · required
    • typestring · enum · required
      Enum values:
      webhook
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_sqs
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      rabbitmq
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      hookdeck
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • config
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_kinesis
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      azure_servicebus
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_s3
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      gcp_pubsub
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly

​Delete Destination

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

​Delete Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​Delete Destination › Responses

    • successboolean

​Update Destination

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

​Update Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​Update Destination › Request Body

  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • config
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject
  • topics
  • filterobject
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​Update Destination › Responses

    • idstring · required
    • typestring · enum · required
      Enum values:
      webhook
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_sqs
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      rabbitmq
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      hookdeck
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • config
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_kinesis
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      azure_servicebus
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_s3
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      gcp_pubsub
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly

​Enable Destination

PUT
http://localhost:3333/api/v1
/tenants/{tenant_id}/destinations/{destination_id}/enable

​Enable Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​Enable Destination › Responses

    • idstring · required
    • typestring · enum · required
      Enum values:
      webhook
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_sqs
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      rabbitmq
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      hookdeck
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • config
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_kinesis
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      azure_servicebus
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_s3
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      gcp_pubsub
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly

​Disable Destination

PUT
http://localhost:3333/api/v1
/tenants/{tenant_id}/destinations/{destination_id}/disable

​Disable Destination › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​Disable Destination › Responses

    • idstring · required
    • typestring · enum · required
      Enum values:
      webhook
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_sqs
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      rabbitmq
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      hookdeck
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • config
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_kinesis
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      azure_servicebus
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • updated_atstring · date-time
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      aws_s3
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly
    • idstring · required
    • typestring · enum · required
      Enum values:
      gcp_pubsub
    • topicsrequired
    • disabled_atstring · date-time · required
    • created_atstring · date-time · required
    • updated_atstring · date-time · required
    • configobject · required
    • credentialsobject · required
    • filterobject
    • delivery_metadataobject
    • metadataobject
    • targetstring · readOnly
    • target_urlstring · url · readOnly

​List Destination Attempts

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

​List Destination Attempts › path Parameters

  • tenant_idstring · required
  • destination_idstring · required

​List Destination Attempts › query Parameters

  • 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 Destination Attempts › Responses

    • modelsobject[]
    • paginationobject

​Get Destination Attempt

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

​Get Destination Attempt › path Parameters

  • tenant_idstring · required
  • destination_idstring · required
  • attempt_idstring · required

​Get Destination Attempt › query Parameters

  • include

​Get Destination Attempt › Responses

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