Outpost API

​Schemas

​Tenant

  • idstring
  • destinations_countinteger
  • topicsstring[]
  • metadataobject
  • created_atstring · date-time
  • updated_atstring · date-time

​TenantUpsert

  • metadataobject

​PortalRedirect

  • redirect_urlstring · url

​TenantToken

  • tokenstring

​SuccessResponse

  • successboolean

​Topics

string · enum
Enum values:
*
string

​PaginatedResponse

  • countinteger · required
  • dataarray · required
  • nextstring · required
  • prevstring · required

​WebhookConfig

  • urlstring · url · required

​WebhookCredentials

  • secretstring
  • previous_secretstring
  • previous_secret_invalid_atstring · date-time

​AWSSQSConfig

  • queue_urlstring · url · required
  • endpointstring · url

​AWSSQSCredentials

  • keystring · required
  • secretstring · required
  • sessionstring

​RabbitMQConfig

  • server_urlstring · required
  • exchangestring · required
  • tlsstring · enum
    Enum values:
    true
    false

​RabbitMQCredentials

  • usernamestring · required
  • passwordstring · required

​HookdeckCredentials

  • tokenstring · required

​AWSKinesisConfig

  • stream_namestring · required
  • regionstring · required
  • endpointstring · url
  • partition_key_templatestring

​AWSKinesisCredentials

  • keystring · required
  • secretstring · required
  • sessionstring

​AzureServiceBusConfig

  • namestring · required

​AzureServiceBusCredentials

  • connection_stringstring · required

​AWSS3Config

  • bucketstring · required
  • regionstring · pattern: ^[a-z]{2}-[a-z]+-[0-… · required
  • key_templatestring
  • storage_classstring

​AWSS3Credentials

  • keystring · required
  • secretstring · required
  • sessionstring

​GCPPubSubConfig

  • project_idstring · required
  • topicstring · required
  • endpointstring

​GCPPubSubCredentials

  • service_account_jsonstring · required

​DestinationWebhook

  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationAWSSQS

  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationRabbitMQ

  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationHookdeck

  • idstring · required
  • typestring · enum · required
    Enum values:
    hookdeck
  • topicsrequired
  • disabled_atstring · date-time · required
  • created_atstring · date-time · required
  • credentialsobject · required
  • updated_atstring · date-time
  • config
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationAWSKinesis

  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationAzureServiceBus

  • idstring · required
  • typestring · enum · required
    Enum values:
    azure_servicebus
  • topicsrequired
  • disabled_atstring · date-time · required
  • created_atstring · date-time · required
  • configobject · required
  • credentialsobject · required
  • updated_atstring · date-time
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationAWSS3

  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationGCPPubSub

  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​Destination

  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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
  • delivery_metadataobject
  • metadataobject
  • targetstring · readOnly
  • target_urlstring · url · readOnly

​DestinationCreateWebhook

  • typestring · enum · required
    Enum values:
    webhook
  • topicsrequired
  • configobject · required
  • idstring
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationCreateAWSSQS

  • typestring · enum · required
    Enum values:
    aws_sqs
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • delivery_metadataobject
  • metadataobject

​DestinationCreateRabbitMQ

  • typestring · enum · required
    Enum values:
    rabbitmq
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • delivery_metadataobject
  • metadataobject

​DestinationCreateHookdeck

  • typestring · enum · required
    Enum values:
    hookdeck
  • topicsrequired
  • credentialsobject · required
  • idstring
  • config
  • delivery_metadataobject
  • metadataobject

​DestinationCreateAWSKinesis

  • typestring · enum · required
    Enum values:
    aws_kinesis
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • delivery_metadataobject
  • metadataobject

​DestinationCreateAzureServiceBus

  • typestring · enum · required
    Enum values:
    azure_servicebus
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • delivery_metadataobject
  • metadataobject

​DestinationCreateAWSS3

  • typestring · enum · required
    Enum values:
    aws_s3
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • delivery_metadataobject
  • metadataobject

​DestinationCreateGCPPubSub

  • typestring · enum · required
    Enum values:
    gcp_pubsub
  • topicsrequired
  • configobject · required
  • credentialsobject · required
  • idstring
  • delivery_metadataobject
  • metadataobject

​DestinationCreate

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

​WebhookCredentialsUpdate

  • secretstring
  • previous_secretstring
  • previous_secret_invalid_atstring · date-time
  • rotate_secretboolean

​DestinationUpdateWebhook

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateAWSSQS

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateRabbitMQ

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateHookdeck

  • topics
  • config
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateAWSKinesis

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateAzureServiceBus

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateAWSS3

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdateGCPPubSub

  • topics
  • configobject
  • credentialsobject
  • delivery_metadataobject
  • metadataobject

​DestinationUpdate

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

​PublishRequest

  • dataobject · required
  • idstring
  • tenant_idstring
  • destination_idstring
  • topicstring
  • eligible_for_retryboolean
  • metadataobject

​PublishResponse

  • idstring · required

​Event

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

​DeliveryAttempt

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

​DestinationTypeSchema

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

​DestinationSchemaField

  • typestring · enum · required
    Enum values:
    text
    checkbox
  • requiredboolean · required
  • labelstring
  • descriptionstring
  • sensitiveboolean
  • defaultstring
  • minlengthinteger
  • maxlengthinteger
  • patternstring