Configuration

Update Managed Configuration

Changed on Oct 21, 2026

Updates one or more managed Outpost configuration values. Null values clear the configuration and reverts to Outpost default behavior.

This endpoint is only available on managed Outpost. In self-hosted deployments, configuration is controlled through environment variables instead.

Only the supported configuration keys are accepted.

patch/config

Request

Base URL
https://api.outpost.hookdeck.com/2025-07-01
Auth
- HTTP bearer
- or HTTP bearer

Request body

ALERT_AUTO_DISABLE_DESTINATIONstring nullable

If "true", automatically disables a destination once ALERT_CONSECUTIVE_FAILURE_COUNT is reached. Has no effect when consecutive-failure alerting is disabled.

ALERT_CONSECUTIVE_FAILURE_COUNTstring nullable

Consecutive delivery failures before alerting on a destination (and disabling it when ALERT_AUTO_DISABLE_DESTINATION is "true"). Omit for the default of 100; set to an empty string to disable consecutive-failure alerting entirely.

ALERT_EXHAUSTED_RETRIES_WINDOW_SECONDSstring nullable

Suppression window in seconds for exhausted_retries alerts: the first exhaustion per destination alerts and subsequent ones within the window are suppressed ("0" = no suppression). Omit for the default of 3600; set to an empty string to disable exhausted_retries alerting entirely.

DELIVERY_TIMEOUT_SECONDSstring nullable

DESTINATIONS_AWS_KINESIS_METADATA_IN_PAYLOADstring nullable

DESTINATIONS_INCLUDE_MILLISECOND_TIMESTAMPstring nullable

DESTINATIONS_PROXY_URLstring nullable

HTTP forward proxy for webhook, RabbitMQ and Kafka destinations, as a single http(s) URL (e.g., "http://user:pass@proxy.example.com:8080"). RabbitMQ and Kafka connections are tunneled with CONNECT, so the proxy must allow CONNECT to the broker ports. Set to an empty string to remove the proxy.

DESTINATIONS_WEBHOOK_COMPAT_HEADERSstring nullable

Additional headers sent with the compat signature, as comma-separated "name=template" pairs. Available variables: {{.EventID}}, {{.Topic}}, {{.Timestamp}}. Use "," for a literal comma in a template.

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_ALGORITHMstring nullable

Algorithm for the compat signature. Defaults to "hmac-sha256".

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_CONTENT_TEMPLATEstring nullable

Go template for the content signed by the compat signature. Same variables as DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATE. Defaults to "{{.Body}}".

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_ENCODINGstring nullable

Encoding for the compat signature ("hex" or "base64"). Defaults to "hex".

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_HEADER_NAMEstring nullable

Complete name of the compat signature header. Setting it sends a second signature, in a previous scheme, alongside the primary one.

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_HEADER_TEMPLATEstring nullable

Go template for the value of the compat signature header. Same variables as DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATE. Defaults to "v0={{.Signatures | join ","}}".

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_SECRET_ENCODINGstring nullable

How the compat signature derives its HMAC key from the destination secret: "raw", "base64" or "hex". Defaults to "raw". A destination whose secret can't be decoded doesn't receive the compat signature.

DESTINATIONS_WEBHOOK_COMPAT_SIGNATURE_SECRET_PREFIXstring nullable

Prefix stripped from the destination secret before decoding for the compat signature (e.g., "whsec_").

DESTINATIONS_WEBHOOK_EVENT_ID_HEADER_NAMEstring nullable

Complete name of the event ID header. Unset uses the default "<prefix>event-id"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_HEADER_PREFIXstring nullable

DESTINATIONS_WEBHOOK_MODEstring nullable

DESTINATIONS_WEBHOOK_PROXY_URLstring nullable

Deprecated alias of DESTINATIONS_PROXY_URL: reads return the same value and writes set DESTINATIONS_PROXY_URL. A request that changes both keys to different values is rejected.

DESTINATIONS_WEBHOOK_SIGNATURE_ALGORITHMstring nullable

DESTINATIONS_WEBHOOK_SIGNATURE_CONTENT_TEMPLATEstring nullable

DESTINATIONS_WEBHOOK_SIGNATURE_ENCODINGstring nullable

DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_NAMEstring nullable

Complete name of the signature header. Unset uses the default "<prefix>signature"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_SIGNATURE_HEADER_TEMPLATEstring nullable

DESTINATIONS_WEBHOOK_SIGNATURE_SECRET_ENCODINGstring nullable

How the signature derives its HMAC key from the destination secret: "raw" uses the secret as-is, "base64" and "hex" decode it. Defaults to "raw". DESTINATIONS_WEBHOOK_SIGNING_SECRET_TEMPLATE must generate secrets this encoding can decode. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_SIGNATURE_SECRET_PREFIXstring nullable

Prefix stripped from the destination secret before decoding (e.g., "whsec_"). Ignored when DESTINATIONS_WEBHOOK_SIGNATURE_SECRET_ENCODING is "raw". Only applies to "default" mode.

DESTINATIONS_WEBHOOK_SIGNING_SECRET_TEMPLATEstring nullable

DESTINATIONS_WEBHOOK_TIMESTAMP_FORMATstring nullable

Format of the timestamp header: "rfc3339", "unix" (seconds since the epoch) or "iso8601_milli_no_offset" (UTC with milliseconds and no offset, e.g. "2026-10-05T15:02:25.447"). Defaults to "rfc3339". Only applies to "default" mode.

DESTINATIONS_WEBHOOK_TIMESTAMP_HEADER_NAMEstring nullable

Complete name of the timestamp header. Unset uses the default "<prefix>timestamp"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

DESTINATIONS_WEBHOOK_TOPIC_HEADER_NAMEstring nullable

Complete name of the topic header. Unset uses the default "<prefix>topic"; an explicit value pins that exact name; an empty string disables the header. Only applies to "default" mode.

HTTP_USER_AGENTstring nullable

IDGEN_ATTEMPT_PREFIXstring nullable

IDGEN_DESTINATION_PREFIXstring nullable

IDGEN_EVENT_PREFIXstring nullable

IDGEN_TYPEstring nullable

MAX_DESTINATIONS_PER_TENANTstring nullable

PORTAL_BRAND_COLORstring nullable

PORTAL_DISABLE_OUTPOST_BRANDINGstring nullable

PORTAL_FAVICON_URLstring nullable

PORTAL_FORCE_THEMEstring nullable

PORTAL_LOGOstring nullable

PORTAL_LOGO_DARKstring nullable

PORTAL_ORGANIZATION_NAMEstring nullable

PORTAL_REFERER_URLstring nullable

PORTAL_REFRESH_URLstring nullable

PORTAL_ENABLE_DESTINATION_FILTERstring nullable

PORTAL_ENABLE_WEBHOOK_CUSTOM_HEADERSstring nullable

RETRY_INTERVAL_SECONDSstring nullable

MAX_RETRY_LIMITstring nullable

RETRY_SCHEDULEstring nullable

OTEL_EXPORTER_OTLP_ENDPOINTstring nullable

OTEL_EXPORTER_OTLP_HEADERSstring nullable

OTEL_EXPORTER_OTLP_PROTOCOLstring nullable

OTEL_EXPORTER_OTLP_TRACES_ENDPOINTstring nullable

OTEL_EXPORTER_OTLP_METRICS_ENDPOINTstring nullable

OTEL_EXPORTER_OTLP_LOGS_ENDPOINTstring nullable

OTEL_SERVICE_NAMEstring nullable

PUBLISH_AWS_SQS_ACCESS_KEY_IDstring nullable

PUBLISH_AWS_SQS_ENDPOINTstring nullable

PUBLISH_AWS_SQS_QUEUEstring nullable

PUBLISH_AWS_SQS_REGIONstring nullable

PUBLISH_AWS_SQS_SECRET_ACCESS_KEYstring nullable

PUBLISH_AZURE_SERVICEBUS_CONNECTION_STRINGstring nullable

PUBLISH_AZURE_SERVICEBUS_SUBSCRIPTIONstring nullable

PUBLISH_AZURE_SERVICEBUS_TOPICstring nullable

PUBLISH_GCP_PUBSUB_PROJECTstring nullable

PUBLISH_GCP_PUBSUB_SERVICE_ACCOUNT_CREDENTIALSstring nullable

PUBLISH_GCP_PUBSUB_SUBSCRIPTIONstring nullable

PUBLISH_GCP_PUBSUB_TOPICstring nullable

PUBLISH_RABBITMQ_EXCHANGEstring nullable

PUBLISH_RABBITMQ_QUEUEstring nullable

PUBLISH_RABBITMQ_SERVER_URLstring nullable

TOPICSstring nullable

TOPICS_ALLOW_WILDCARDSstring nullable

Example request

{
  "TOPICS": "user.created,user.updated",
  "DESTINATIONS_WEBHOOK_MODE": "default"
}

Response

Updated managed configuration.