Outpost API

​Schemas

​Tenant

  • idstring

    User-defined system ID for the tenant.

  • destinations_countinteger

    Number of destinations associated with the tenant.

  • topicsstring[]

    List of subscribed topics across all destinations for this tenant.

  • created_atstring · date-time

    ISO Date when the tenant was created.

​PortalRedirect

  • redirect_urlstring · url

    Redirect URL containing a JWT to authenticate the user with the portal.

​TenantToken

  • tokenstring

    JWT token scoped to the tenant for safe browser API calls.

​SuccessResponse

  • successboolean

​DestinationOAuthRedirect

  • redirect_urlstring · url

    Redirect URL for OAuth flow if applicable during destination update.

​Topics

string · enum
Enum values:
*
string[]
string

​WebhookConfig

  • urlstring · url · required

    The URL to send the webhook events to.

​WebhookCredentials

  • secretstring

    The secret used for signing webhook requests. Auto-generated if omitted on creation by admin. Read-only for tenants unless rotating.

  • previous_secretstring

    The previous secret used during rotation. Valid for 24 hours by default. Read-only.

  • previous_secret_invalid_atstring · date-time

    ISO timestamp when the previous secret becomes invalid. Read-only.

​AWSSQSConfig

  • queue_urlstring · url · required

    The URL of the SQS queue.

  • endpointstring · url

    Optional. Custom AWS endpoint URL (e.g., for LocalStack or specific regions).

​AWSSQSCredentials

  • keystring · required

    AWS Access Key ID.

  • secretstring · required

    AWS Secret Access Key.

  • sessionstring

    Optional AWS Session Token (for temporary credentials).

​RabbitMQConfig

  • server_urlstring · required

    RabbitMQ server address (host:port).

  • exchangestring · required

    The exchange to publish messages to.

  • tlsstring · enum

    Whether to use TLS connection (amqps). Defaults to "false".

    Enum values:
    true
    false

​RabbitMQCredentials

  • usernamestring · required

    RabbitMQ username.

  • passwordstring · required

    RabbitMQ password.

​DestinationWebhook

  • idstring · required

    Control plane generated ID or user provided ID for the destination.

  • typestring · enum · required

    Type of the destination.

    Enum values:
    webhook
  • topicsrequired

    "*" or an array of enabled topics.

  • disabled_atstring · date-time · required

    ISO Date when the destination was disabled, or null if enabled.

  • created_atstring · date-time · required

    ISO Date when the destination was created.

  • configobject · required
  • credentialsobject · required

​DestinationAWSSQS

  • idstring · required

    Control plane generated ID or user provided ID for the destination.

  • typestring · enum · required

    Type of the destination.

    Enum values:
    aws_sqs
  • topicsrequired

    "*" or an array of enabled topics.

  • disabled_atstring · date-time · required

    ISO Date when the destination was disabled, or null if enabled.

  • created_atstring · date-time · required

    ISO Date when the destination was created.

  • configobject · required
  • credentialsobject · required

​DestinationRabbitMQ

  • idstring · required

    Control plane generated ID or user provided ID for the destination.

  • typestring · enum · required

    Type of the destination.

    Enum values:
    rabbitmq
  • topicsrequired

    "*" or an array of enabled topics.

  • disabled_atstring · date-time · required

    ISO Date when the destination was disabled, or null if enabled.

  • created_atstring · date-time · required

    ISO Date when the destination was created.

  • configobject · required
  • credentialsobject · required

​Destination

  • idstring · required

    Control plane generated ID or user provided ID for the destination.

  • typestring · enum · required

    Type of the destination.

    Enum values:
    webhook
  • topicsrequired

    "*" or an array of enabled topics.

  • disabled_atstring · date-time · required

    ISO Date when the destination was disabled, or null if enabled.

  • created_atstring · date-time · required

    ISO Date when the destination was created.

  • configobject · required
  • credentialsobject · required
  • idstring · required

    Control plane generated ID or user provided ID for the destination.

  • typestring · enum · required

    Type of the destination.

    Enum values:
    aws_sqs
  • topicsrequired

    "*" or an array of enabled topics.

  • disabled_atstring · date-time · required

    ISO Date when the destination was disabled, or null if enabled.

  • created_atstring · date-time · required

    ISO Date when the destination was created.

  • configobject · required
  • credentialsobject · required
  • idstring · required

    Control plane generated ID or user provided ID for the destination.

  • typestring · enum · required

    Type of the destination.

    Enum values:
    rabbitmq
  • topicsrequired

    "*" or an array of enabled topics.

  • disabled_atstring · date-time · required

    ISO Date when the destination was disabled, or null if enabled.

  • created_atstring · date-time · required

    ISO Date when the destination was created.

  • configobject · required
  • credentialsobject · required

​DestinationCreateWebhook

  • typestring · enum · required

    Type of the destination. Must be 'webhook'.

    Enum values:
    webhook
  • topicsrequired

    "*" or an array of enabled topics.

  • configobject · required
  • idstring

    Optional user-provided ID. A UUID will be generated if empty.

  • credentialsobject

​DestinationCreateAWSSQS

  • typestring · enum · required

    Type of the destination. Must be 'aws_sqs'.

    Enum values:
    aws_sqs
  • topicsrequired

    "*" or an array of enabled topics.

  • configobject · required
  • credentialsobject · required
  • idstring

    Optional user-provided ID. A UUID will be generated if empty.

​DestinationCreateRabbitMQ

  • typestring · enum · required

    Type of the destination. Must be 'rabbitmq'.

    Enum values:
    rabbitmq
  • topicsrequired

    "*" or an array of enabled topics.

  • configobject · required
  • credentialsobject · required
  • idstring

    Optional user-provided ID. A UUID will be generated if empty.

​DestinationCreate

  • typestring · enum · required

    Type of the destination. Must be 'webhook'.

    Enum values:
    webhook
  • topicsrequired

    "*" or an array of enabled topics.

  • configobject · required
  • idstring

    Optional user-provided ID. A UUID will be generated if empty.

  • credentialsobject
  • typestring · enum · required

    Type of the destination. Must be 'aws_sqs'.

    Enum values:
    aws_sqs
  • topicsrequired

    "*" or an array of enabled topics.

  • configobject · required
  • credentialsobject · required
  • idstring

    Optional user-provided ID. A UUID will be generated if empty.

  • typestring · enum · required

    Type of the destination. Must be 'rabbitmq'.

    Enum values:
    rabbitmq
  • topicsrequired

    "*" or an array of enabled topics.

  • configobject · required
  • credentialsobject · required
  • idstring

    Optional user-provided ID. A UUID will be generated if empty.

​WebhookCredentialsUpdate

  • secretstring

    New secret (only allowed for admin).

  • previous_secretstring

    Previous secret for rotation (only allowed for admin).

  • previous_secret_invalid_atstring · date-time

    Invalidation time for previous secret (only allowed for admin).

  • rotate_secretboolean

    Set to true to rotate the secret. The current secret becomes the previous_secret, and a new secret is generated. previous_secret_invalid_at defaults to 24h if not provided.

​DestinationUpdateWebhook

  • topics

    "*" or an array of enabled topics.

  • configobject
  • credentialsobject

​DestinationUpdateAWSSQS

  • topics

    "*" or an array of enabled topics.

  • configobject
  • credentialsobject

​DestinationUpdateRabbitMQ

  • topics

    "*" or an array of enabled topics.

  • configobject
  • credentialsobject

​DestinationUpdate

  • topics

    "*" or an array of enabled topics.

  • configobject
  • credentialsobject
  • topics

    "*" or an array of enabled topics.

  • configobject
  • credentialsobject
  • topics

    "*" or an array of enabled topics.

  • configobject
  • credentialsobject

​PublishRequest

  • tenant_idstring · required

    The ID of the tenant to publish for.

  • topicstring · required

    Topic name for the event.

  • eligible_for_retryboolean · required

    Should event delivery be retried on failure.

  • dataobject · required

    Any JSON payload for the event data.

  • destination_idstring

    Optional. Route event to a specific destination.

  • metadataobject

    Any key-value string pairs for metadata.

​Event

  • idstring
  • destination_idstring
  • topicstring
  • timestring · date-time

    Time the event was received/processed.

  • successful_atstring · date-time

    Time the event was successfully delivered.

  • metadataobject

    Key-value string pairs of metadata associated with the event.

  • dataobject

    Freeform JSON data of the event.

​DeliveryAttempt

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

​DestinationTypeSchema

  • typestring
  • labelstring
  • descriptionstring
  • iconstring

    SVG icon string.

  • instructionsstring

    Markdown instructions.

  • remote_setup_urlstring · url

    Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a remote_setup_url is set then the user should be prompted to follow the link to configure the destination. See the dashboard design guide for recommended UI patterns and wireframes for implementation in your own app.

  • config_fieldsobject[]

    Config fields are non-secret values that can be stored and displayed to the user in plain text.

  • credential_fieldsobject[]

    Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.

​DestinationSchemaField

  • typestring · enum
    Enum values:
    text
    number
    boolean
  • labelstring
  • descriptionstring
  • validationstring

    Regex string for validation.

  • requiredboolean