Outpost API

Schemas

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

List Destination Type Schemas (for Tenant)

GET
http://localhost:3333/api/v1
/{tenant_id}/destination-types

List Destination Type Schemas (for Tenant)path Parameters

  • tenant_idstring · required

List Destination Type Schemas (for Tenant)Responses

    • typestring
    • labelstring
    • descriptionstring
    • iconstring
    • instructionsstring
    • remote_setup_urlstring · url
    • config_fieldsobject[]
    • credential_fieldsobject[]

Get Destination Type Schema (for Tenant)

GET
http://localhost:3333/api/v1
/{tenant_id}/destination-types/{type}

Get Destination Type Schema (for Tenant)path Parameters

  • tenant_idstring · required
  • typestring · enum · required
    Enum values:
    webhook
    aws_sqs
    rabbitmq
    hookdeck
    aws_kinesis

Get Destination Type Schema (for Tenant)Responses

    • typestring
    • labelstring
    • descriptionstring
    • iconstring
    • instructionsstring
    • remote_setup_urlstring · url
    • config_fieldsobject[]
    • credential_fieldsobject[]

List Destination Type Schemas (JWT Auth)

GET
http://localhost:3333/api/v1
/destination-types

List Destination Type Schemas (JWT Auth)Responses

    • typestring
    • labelstring
    • descriptionstring
    • iconstring
    • instructionsstring
    • remote_setup_urlstring · url
    • config_fieldsobject[]
    • credential_fieldsobject[]

Get Destination Type Schema

GET
http://localhost:3333/api/v1
/destination-types/{type}

Get Destination Type Schemapath Parameters

  • typestring · enum · required
    Enum values:
    webhook
    aws_sqs
    rabbitmq
    hookdeck
    aws_kinesis

Get Destination Type SchemaResponses

    • typestring
    • labelstring
    • descriptionstring
    • iconstring
    • instructionsstring
    • remote_setup_urlstring · url
    • config_fieldsobject[]
    • credential_fieldsobject[]