--- title: "Get destination" method: GET path: "/api/{workspaceId}/config/destination/{id}" tags: ["Destinations"] --- # Get destination `GET /api/{workspaceId}/config/destination/{id}` ## Request - Base URL: `https://use.jitsu.com` - URL: `https://use.jitsu.com/api/{workspaceId}/config/destination/{id}` - Auth: HTTP bearer ## Path parameters - `workspaceId` string, required - `id` string, required ## Response `200` OK - union - DestinationTag: Inserts any html or javascript into your page. Use this to add any third party tracking code as Google Analytics, Facebook Pixel, Twitter Pixel, etc. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'tag', required - `provisioned` boolean - `testConnectionError` string - `code` string, required: Code to insert into site page in html or javascript format - DestinationGa4Tag: Tracks users in Google Analytics with client side code snippet. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'ga4-tag', required - `provisioned` boolean - `testConnectionError` string - `measurementIds` string, required: Measurement ID::Measurement ID of your Google Analytics 4 properties. How to find - `autoPageView` boolean: Rely on Enhanced event measurement to track page views. Jitsu page event will be ignored. - DestinationGtm: Installs Google Tag Manager client code and sends events to Google Tag Manager. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'gtm', required - `provisioned` boolean - `testConnectionError` string - `containerId` string, required: The Container ID uniquely identifies the GTM Container. - `dataLayerName` string: The name of the data layer variable. - `loadGtm` boolean: Load GTM::Whether Jitsu should load the Google Tag Manager script. Disable this if you load GTM yourself (e.g. on page load) so tags are ready before navigation — Jitsu will only push events to the data layer. - `resetDataLayer` boolean: Reset Data Layer::Clear the data Jitsu pushed after each event so values don't leak between events. GTM merges every push into a single persistent data model, so without resetting, properties from one event (event properties, traits, user data, etc.) stay set and can be picked up by tags firing on later, unrelated events. Recommended. Disable only if you intentionally rely on values persisting across events, or if another system already manages clearing the data layer. - DestinationLogrocket: Log Rocket is a session replay tool that helps you understand how users interact with your app. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'logrocket', required - `provisioned` boolean - `testConnectionError` string - `appId` string, required: Log Rocket App ID. Go to Settings » Project Setup » General Settings to find it - DestinationClarity: Microsoft Clarity is a free heatmap and session-recording tool. Jitsu attaches user identity, tags and custom events to Clarity sessions with a client-side snippet. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'clarity', required - `provisioned` boolean - `testConnectionError` string - `projectId` string, required: Project ID::Your Clarity Project ID. Open your Clarity project » Settings » Overview to find it. It also serves as the API key. Only used when Jitsu loads the Clarity tag. - `loadClarity` boolean: Load Clarity::Whether Jitsu should load the Microsoft Clarity tag. Disable this if you already load Clarity yourself (e.g. via your own snippet or a tag manager) — Jitsu will only forward events to the existing Clarity instance and the Project ID is ignored. - `cookieConsent` boolean: Cookie consent::Call clarity('consent') after the tag loads. Enable this if you rely on Clarity's cookie consent gate. - `trackProperties` 'tags' | 'ignore': Track event properties::Clarity custom events carry only a name. Choose tags to also forward track properties as filterable Clarity custom tags, or ignore to send the event name only. - DestinationHotjar: Hotjar is a heatmap, session-recording and survey tool. Jitsu attaches user attributes and custom events to Hotjar with a client-side snippet. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'hotjar', required - `provisioned` boolean - `testConnectionError` string - `siteId` string, required: Site ID::Your Hotjar Site ID (the numeric hjid). Find it in Hotjar » Settings » Sites & Organizations, or in your tracking-code snippet. Only used when Jitsu loads the Hotjar tag. - `loadHotjar` boolean: Load Hotjar::Whether Jitsu should load the Hotjar tag. Disable this if you already load Hotjar yourself (e.g. via your own snippet or a tag manager) — Jitsu will only forward events to the existing Hotjar instance and the Site ID is ignored. - `spaPageViews` boolean: SPA page views::Emit a Hotjar virtual page view (hj('stateChange', path)) on every Jitsu page event. Enable this for single-page apps. Leave off to rely on Hotjar's built-in page detection and avoid double-counting. - `trackProperties` 'ignore' | 'attributes': Track event properties::Hotjar events carry only a name and have no per-event property API. Choose attributes to merge track properties into the identified user's record (requires a known user), or ignore to send the event name only. - DestinationClickhouse: ClickHouse is an open-source column-oriented database management system specialized for online analytical processing of queries (OLAP). - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'clickhouse', required - `provisioned` boolean - `testConnectionError` string - `protocol` 'http' | 'https' | 'clickhouse' | 'clickhouse-secure': Protocol used for ClickHouse connection: http, https, clickhouse, clickhouse-secure - `hosts` string[], required: List of clickhouse servers as host:port. If port is not specified, default port for respective protocol will be used: http->8123, https->8443, clickhouse->9000, clickhouse-secure->9440 - `username` string: Username for ClickHouse connection - `password` string, required: Password for ClickHouse connection - `cluster` string: Name of cluster to use.
For ClickHouse Cloud or single-node setups, leave this field empty. - `database` string: Name of the database to use - `parameters` object: Additional parameters for ClickHouse driver. See Clickhouse documentation - `loadAsJson` boolean: Use JSONEachRow format::Load data in the JSONEachRow format. This method offers better performance but may not work correctly on older ClickHouse versions. - DestinationPostgres: Postgres is a powerful, open source object-relational database system. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'postgres', required - `provisioned` boolean - `testConnectionError` string - `authenticationMethod` 'password' | 'google-psc': Authentication Method::Standard username/password or Private Service Connect for Google-managed postgres instances only. - `instanceConnectionName` string: Instance Connection Name::Google SQL instance Connection Name in the format project-name:region:instance-name. How to obtain. - `host` string: Postgres host - `port` number: Postgres port - `sslMode` 'disable' | 'require' | 'verify-ca' | 'verify-full': SSL Mode::SSL mode for Postgres connection: disable,require,verify-ca,verify-full - `sslServerCA` string: SSL Server CA:: - `sslClientCert` string: SSL Client Cert:: - `sslClientKey` string: SSL Client Key:: - `database` string, required: Postgres database name - `username` string: Postgres username - `password` string: Postgres password - `defaultSchema` string: Schema::Postgres schema - DestinationBigquery: BigQuery is a cloud-based SQL data warehouse service developed by Google. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'bigquery', required - `provisioned` boolean - `testConnectionError` string - `project` string, required: Project ID::Google Cloud Project ID. Locate Project ID - `bqDataset` string, required: Dataset::BigQuery Dataset - `location` string: Query location::Optional BigQuery region for Reverse ETL. If omitted, Jitsu reads the configured dataset's location. - `maximumBytesBilled` string: Maximum bytes billed per query::Optional Reverse ETL query cost limit, in bytes. Without a limit, normal BigQuery query pricing applies. LIMIT in a preview does not limit bytes scanned. - `keyFile` string, required: Access Key::Google Service Account JSON for BigQuery. Read more about Google Authorization - DestinationSnowflake: Snowflake is an independent a cloud data warehouse with compute-based pricing. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'snowflake', required - `provisioned` boolean - `testConnectionError` string - `authenticationMethod` 'key-pair' | 'password': Authentication Method::Snowflake authentication method: Key-pair or username/password - `username` string: Snowflake username - `password` string: Snowflake password - `privateKey` string: Private Key::Snowflake private key. Generate the private key - `privateKeyPassphrase` string - `account` string, required: Snowflake account name - `warehouse` string, required: Snowflake warehouse name - `database` string, required: Snowflake database name - `defaultSchema` string: Schema::Snowflake schema - `parameters` object: Additional Snowflake connection parameters - DestinationRedshift: Amazon Redshift is a cloud data warehouse that is optimized for the analytical workloads of business intelligence (BI) and data warehousing (DWH). Jitsu supports both Serverless and Classic Redshift - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'redshift', required - `provisioned` boolean - `testConnectionError` string - `authenticationMethod` 'iam' | 'password': Authentication Method::Redshift authentication method: IAM Role based or database username/password - `serverless` boolean: Redshift Serverless:: - `region` 'us-west-1' | 'us-west-2' | 'us-east-2' | 'us-east-1' | 'ap-south-1' | 'ap-northeast-3' | 'ap-northeast-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-northeast-1' | 'ca-central-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-west-1' | 'eu-west-2' | 'eu-south-1' | 'eu-west-3' | 'eu-north-1' | 'me-south-1' | 'sa-east-1' | 'us-gov-east-1' | 'us-gov-west-1', required: Region::Aws Region - `clusterIdentifier` string: Cluster Identifier::Redshift cluster identifier - `workgroupName` string: Workgroup name::Redshift Serverless workgroup name - `roleARN` string: Role ARN::IAM role ARN. How to create - `externalID` string: External ID::IAM external ID - `host` string: Redshift host - `port` integer: Redshift port - `database` string, required: Redshift database name - `defaultSchema` string: Schema::Redshift schema - `username` string: Redshift username - `password` string: Redshift password - `bucket` string: S3 Bucket Name::Required for ingestion connections and ordinary syncs. Not needed when this warehouse is only a Reverse ETL model source. - `accessKeyId` string: S3 Access Key Id::S3 Access Key Id. Create access key - `secretAccessKey` string: S3 Secret Access Key::S3 Secret Access Key - DestinationDuckdb: DuckDB-powered cloud data warehouse scaling to terabytes with ease. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'duckdb', required - `provisioned` boolean - `testConnectionError` string - `database` string, required: MotherDuck database name - `motherduckToken` string, required: MotherDuck token::MotherDuck token can be obtained in the MotherDuck's Settings -> Access Tokens section - `defaultSchema` string: Schema::Database schema - DestinationMysql: MySQL is a popular open source object-relational database system. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'mysql', required - `provisioned` boolean - `testConnectionError` string - `host` string, required: Mysql host - `port` number: Mysql port - `database` string, required: Mysql database name - `username` string, required: Mysql username - `password` string, required: Mysql password - `parameters` object: Additional Mysql connection parameters - `tls` 'true' | 'false' | 'skip-verify' | 'preferred', required - DestinationS3: S3 is a cloud file storage service by Amazon - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 's3', required - `provisioned` boolean - `testConnectionError` string - `authenticationMethod` 'iam' | 'accessKey': Authentication Method::S3 authentication method: IAM Role based or Access Key - `region` 'us-west-1' | 'us-west-2' | 'us-east-2' | 'us-east-1' | 'ap-south-1' | 'ap-northeast-3' | 'ap-northeast-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-northeast-1' | 'ca-central-1' | 'cn-north-1' | 'cn-northwest-1' | 'eu-central-1' | 'eu-west-1' | 'eu-west-2' | 'eu-south-1' | 'eu-west-3' | 'eu-north-1' | 'me-south-1' | 'sa-east-1' | 'us-gov-east-1' | 'us-gov-west-1': S3 Region::S3 Region - `roleARN` string: Role ARN::IAM role ARN. How to create - `externalID` string: External ID::IAM external ID - `accessKeyId` string: S3 Access Key Id::S3 Access Key Id. Create access key - `secretAccessKey` string: S3 Secret Access Key::S3 Secret Access Key - `bucket` string, required: S3 Bucket Name::S3 Bucket Name - `endpoint` string: Custom endpoint of S3-compatible server - `folder` string: Folder in the block storage bucket where files will be stored - `format` 'ndjson' | 'ndjson_flat' | 'csv': Format of the files stored in the block storage: ndjson - Newline Delimited JSON, ndjson_flat - Newline Delimited JSON flattened, csv - CSV - `compression` 'gzip' | 'zstd' | 'none': Compression mode used for the files stored in the block storage:
gzip - files will be compressed and have .gz filename suffix and Content-Type: application/gzip
zstd - Zstandard compression, .zst filename suffix and Content-Type: application/zstd. Smaller and faster than gzip, but check your downstream tooling can read it
none - no compression, Content-Type and file extension will be set according to the format - DestinationGcs: Google Cloud Storage is a cloud file storage service by Google - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'gcs', required - `provisioned` boolean - `testConnectionError` string - `accessKey` string, required: Google Access Key::Google Access Key - `bucket` string, required: GCS Bucket Name::GCS Bucket Name - `folder` string: Folder in the block storage bucket where files will be stored - `format` 'ndjson' | 'ndjson_flat' | 'csv': Format of the files stored in the block storage: ndjson - Newline Delimited JSON, ndjson_flat - Newline Delimited JSON flattened, csv - CSV - `compression` 'gzip' | 'zstd' | 'none': Compression mode used for the files stored in the block storage:
gzip - files will be compressed and have .gz filename suffix and Content-Type: application/gzip
zstd - Zstandard compression, .zst filename suffix and Content-Type: application/zstd. Smaller and faster than gzip, but check your downstream tooling can read it
none - no compression, Content-Type and file extension will be set according to the format - DestinationMixpanel: Mixpanel is a product analytics platform that provides insights into user behavior. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'mixpanel', required - `provisioned` boolean - `testConnectionError` string - `dataResidency` 'US' | 'EU' - `simplifiedIdMerge` boolean: Simplified Identity Merge::Use Mixpanel Simplified Identity Merge feature.
Enable this option if your Mixpanel project has the corresponding feature enabled.
Using this feature is highly recommended to achieve better quality Identity Merge - `projectId` string, required: Project id can be found in the project settings - `projectToken` string, required: See how to obtain project secret - `serviceAccountUserName` string, required: See how to create service account - `serviceAccountPassword` string, required: See how to create service account - `sendPageEvents` boolean: If enabled, all page view events will be sent to Mixpanel. - `sendIdentifyEvents` boolean: If enabled, any identify() call will send an Identify event to Mixpanel in addition to the profile update - `enableGroupAnalytics` boolean: Mixpanel Group Analytics allows behavioral data analysis at a customized group level. Group Analytics is available as an add-on package to customers on Growth and Enterprise plans. - `filterBotTraffic` boolean: Don't send traffic from known bots to Mixpanel - `groupKey` string: Group Key for Mixpanel Group Analytics. Make sure that Group Key in Mixpanel project settings matches the provided value. - `enableAnonymousUserProfiles` boolean: If enabled, anonymous users will be tracked in Mixpanel - DestinationIntercom: Base shape shared by every destination type. Concrete subtypes (DestinationPostgres, DestinationClickhouse, etc.) extend this with type-specific credentials. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'intercom', required - `provisioned` boolean - `testConnectionError` string - `accessToken` string, required: Intercom Access Token. You should first create an app in Intercom Developer Hub, and then generate an access token in the app settings. See a detailed guide - `updateLastSeenOnEveryEvent` boolean: By default, the last seen property will be updated only on .identify() calls. If enabled, the property will be updated on every event. However, enabling this option may lead to higher API usage. - DestinationMicrosoftAds: Sync warehouse models to Customer Match audiences and offline conversion goals. Reverse ETL only; no UET browser tag is required. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'microsoft-ads', required - `provisioned` boolean - `testConnectionError` string - `customerId` string: Customer ID::Manager/customer ID, not your account number. - `accountId` string: Account ID::Numeric advertising account ID, not the alphanumeric account number. - `developerToken` string: Developer token::Optional when configured by your Jitsu administrator. - `authorized` boolean - `oauthIntegrationId` 'jitsu-cloud-dst-microsoft-ads' - `oauthConnectionId` string - DestinationOpenaiAds: Send conversion events to OpenAI Ads through the Conversions API from your site and app event streams, or sync warehouse models as conversion events and Custom Audiences with Reverse ETL. No pixel on your site is required. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'openai-ads', required - `provisioned` boolean - `testConnectionError` string - `conversionsApiKey` string: Conversions API key::Create it in Ads Manager under Conversions. Needed for conversion syncs; it is only used to send events. - `adsApiKey` string: Ads API key::Create it in Ads Manager under Settings. Needed for audience syncs; it can manage this ad account, so use a key made for Jitsu. - `pixelId` string: Pixel ID::Required for event connections: the Pixel ID from Ads Manager (Conversions). Reverse ETL conversions set the pixel on the sync and audiences do not use one. - `events` string: List of events to send, delimited by comma. Following page, screen, or any arbitrary event (name of track event). Special values: empty string - send only track events, * - send all events useful if you want to filter events with Functions - `eventMappings` string: Event names::Map your events to OpenAI events. One eventName=openaiEvent per line, e.g. Order Completed=order_created. Common ecommerce and sign-up events are mapped for you; anything else is sent as a custom event named after your event. - `actionSource` 'web' | 'mobile_app' | 'offline' | 'physical_store' | 'phone_call' | 'email' | 'other': Action source::Where the events happen. Web events need a page URL on every event; use another value for server-only events. - `phoneFieldName` string: Phone trait::Name of the user trait that holds the phone number, including the country code. If empty, no phone number is sent. - DestinationFacebookConversions: Send conversions to Meta or sync warehouse models to Facebook and Instagram Custom Audiences through Reverse ETL. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'facebook-conversions', required - `provisioned` boolean - `testConnectionError` string - `pixelId` string: Pixel / Dataset ID. Required for ordinary event connections. Reverse ETL conversions configure their data source on the sync; audiences do not use a pixel. - `accessToken` string, required: Meta Access Token. For Reverse ETL, use a system-user token with access to the selected ad account or pixel/dataset. - `actionSource` 'email' | 'website' | 'app' | 'phone_call' | 'chat' | 'physical_store' | 'system_generated' | 'other': Action Source - `events` string: List of events to send, delimited by comma. Following page, screen, or any arbitrary event (name of track event). Special values: empty string - send only track events, * - send all events useful if you want to filter events with Functions - `phoneFieldName` string: Name of the field in the event user traits that contains the phone number. Expected format could be E.164 or international format. If empty, phone number hash will not be sent. - DestinationGoogleAds: Base shape shared by every destination type. Concrete subtypes (DestinationPostgres, DestinationClickhouse, etc.) extend this with type-specific credentials. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'google-ads', required - `provisioned` boolean - `testConnectionError` string - `authorized` boolean - `oauthIntegrationId` string - `oauthConnectionId` string - `api` 'data-manager' | 'google-ads': API::Which Google API to send conversions to. - `customerId` string, required: Customer ID::Your Google Ads account ID — 10 digits, found in the top right of the Google Ads UI. Dashes are optional. - `loginCustomerId` string: Manager (MCC) Customer ID::Set this when a manager account is used to access the account above. Leave empty if you authorized directly with the account. - `conversionType` 'conversion' | 'enhancement': Conversion Type::What kind of upload this destination performs. - `conversionActionId` string: Conversion Action ID::The default conversion action for events without a per-event override.
  1. In Google Ads, open Goals » Conversions » Summary in the account that owns the conversion action.
  2. Click the conversion action's name to open its details.
  3. In your browser's address bar, find ctId= and copy only the number immediately after it. For example, ctId=123456789& means enter 123456789.
This is not your Customer ID, the Google tag ID (AW-...), or the conversion label. For Customer Match audience syncs (Reverse ETL), no Conversion Action ID is needed; configure an audience under Reverse ETL » Syncs instead. Google's guide to finding the conversion action ID. - `conversionActions` string[]: Per-event Conversion Actions::Route individual events to different conversion actions. One eventName=conversionActionId per line, e.g. Order Completed=111222333. Events not listed here use the Conversion Action ID above. - `events` string: List of events to send, delimited by comma. Following page, screen, or any arbitrary event (name of track event). Special values: empty string - send only track events, * - send all events useful if you want to filter events with Functions - `eventSource` 'WEB' | 'APP' | 'IN_STORE' | 'PHONE' | 'MESSAGE' | 'OTHER': Event Source::Where the conversion happened. The legacy Google Ads API only understands WEB and APP; other values are omitted from that payload. - `phoneFieldName` string: Phone Trait Name::Name of the field in the event user traits holding the phone number. It is normalized to E.164 and hashed before sending. If empty, no phone number is sent. - `defaultPhoneCountryCode` string: Default Phone Country Code::Prepended to phone numbers that don't already start with +, e.g. +1. Google rejects phone numbers that aren't in E.164 format, so set this if your traits store local numbers. - `developerToken` string: Developer Token::Required for Google Ads API delivery, including Reverse ETL call conversions and conversion adjustments. Leave blank if your Jitsu runner already supplies GOOGLE_ADS_DEVELOPER_TOKEN. Not needed for Data Manager audience or click uploads. Request a token under API Center in your Google Ads manager account. - `storeClickIds` boolean: Remember Click IDs::Jitsu watches every event on this connection for a gclid/gbraid/wbraid and remembers it against the anonymous user for 90 days, so a conversion that fires later still gets attributed. Turn this off to only use click ids present on the converting event itself. - `validateOnly` boolean: Validate Only::Send requests with Google's validateOnly flag. Google checks the payload and reports errors but records nothing. Useful to verify a new setup without polluting conversion data. - DestinationJune: June.so is a product analytics platform that provides insights into user behavior. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'june', required - `provisioned` boolean - `testConnectionError` string - `apiKey` string, required: API Key::To get or create an API Key, go to workspace's "Settings & integrations" > Integrations > June SDK - `enableAnonymousUserProfiles` boolean: If enabled, anonymous users will be tracked in June - DestinationResend: Base shape shared by every destination type. Concrete subtypes (DestinationPostgres, DestinationClickhouse, etc.) extend this with type-specific credentials. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'resend', required - `provisioned` boolean - `testConnectionError` string - `apiKey` string, required: API Key::Create an API key in the Resend dashboard under "API Keys". It needs write access to Contacts. The key starts with "re_". - `audiences` string: Audiences::Comma-separated list of Resend audience names to add identified contacts to (e.g. Customers, Beta). Names are resolved automatically — any that don't exist yet are created. Leave empty to add contacts without an audience. Can be overridden per event with a resendAudiences trait. Membership is reconciled to match the list: audiences the connector previously added that are no longer listed get removed. - `resolveEmailFromUserId` boolean: Resolve email from userId::Resend identifies contacts by email only — it has no notion of a userId. When enabled, every identify() caches a userId → email mapping so later track/page/group events that carry only a userId can still update the matching contact. When disabled (default), only events that carry an email directly are matched; events with just a userId are skipped. - `apiBase` string: API Base URL::Override the Resend API base URL (defaults to https://api.resend.com). For testing or proxying. - DestinationSendgrid: Base shape shared by every destination type. Concrete subtypes (DestinationPostgres, DestinationClickhouse, etc.) extend this with type-specific credentials. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'sendgrid', required - `provisioned` boolean - `testConnectionError` string - `apiKey` string, required: API Key::Create an API key in the SendGrid dashboard under Settings > API Keys. It needs "Marketing" permissions (Read/Write access to Marketing Contacts). - `lists` string: Lists::Comma-separated list of SendGrid marketing list names to add identified contacts to (e.g. Customers, Beta). Names are resolved automatically — any that don't exist yet are created. Leave empty to add contacts without a list. Can be overridden per event with a sendgridLists trait. Membership is reconciled to match the list: lists the connector previously added that are no longer listed get removed. - `region` 'Global' | 'EU': Data Residency::Select "EU" if your SendGrid account uses EU data residency (requests go to api.eu.sendgrid.com). Otherwise leave as "Global" (api.sendgrid.com). - `resolveEmailFromUserId` boolean: Resolve email from userId::SendGrid identifies contacts by email. When enabled, every identify() caches a userId → email mapping so later track/page/group events that carry only a userId can still update the matching contact. When disabled (default), only events that carry an email directly are matched. - `apiBase` string: API Base URL::Override the SendGrid API base URL (defaults to the Global/EU host from Data Residency). For testing or proxying. - DestinationBraze: Braze is a customer engagement platform used by businesses for multichannel marketing. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'braze', required - `provisioned` boolean - `testConnectionError` string - `apiKey` string, required: API Key::Created under Developer Console in the Braze Dashboard. - `endpoint` 'US-01 : dashboard-01.braze.com' | 'US-02 : dashboard-02.braze.com' | 'US-03 : dashboard-03.braze.com' | 'US-04 : dashboard-04.braze.com' | 'US-05 : dashboard-05.braze.com' | 'US-06 : dashboard-06.braze.com' | 'US-07 : dashboard-07.braze.com' | 'US-08 : dashboard-08.braze.com' | 'US-09 : dashboard-09.braze.com' | 'EU-01 : dashboard-01.braze.eu' | 'EU-02 : dashboard-02.braze.eu': Your Braze REST endpoint. More details - `appId` string: App ID::The app identifier used to reference specific Apps in requests made to the Braze API. Created under Developer Console in the Braze Dashboard. - `useJitsuAnonymousIdAlias` boolean: Use Anonymous Id Alias::Use Jitsu anonymousId as an alias for identified and anonymous profiles. Enables support for anonymous (alias-only) profiles. - `sendPageEvents` boolean: Send page and screen events as Braze Custom Events - DestinationSalesforce: Salesforce is the world's leading customer relationship management technology. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'salesforce', required - `provisioned` boolean - `testConnectionError` string - `authorized` boolean - `oauthIntegrationId` string - `oauthConnectionId` string - `isSandbox` boolean: Sandbox Instance::You can log in to a sandbox by switching the login form to use Custom Domain, and providing the login URL of your sandbox, e.g.: MyDomainName--SandboxName.sandbox.my.salesforce.com

Alternatively, you can use the general login form by appending the sandbox name to your Salesforce username. For example, if the production username is user@example.com and the sandbox is named sndbx, the sandbox username would be: user@example.com.sndbx

If you are already authenticated, please Re-Sign In with your sandbox username. - DestinationMongodb: MongoDB is a cross-platform NoSQL document-oriented database. Jitsu supports both self-hosted Mongo and MongoDB Atlas. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'mongodb', required - `provisioned` boolean - `testConnectionError` string - `url` string - `protocol` 'mongodb' | 'mongodb+srv': MongoDB protocol. mongodb or mongodb+srv. For Atlas use mongodb+srv - `hosts` string[]: MongoDB hosts with port (e.g. localhost:27017). One on each line - `username` string, required: MongoDB username - `password` string, required: MongoDB password - `database` string, required: MongoDB database - `collection` string, required: MongoDB collection - `options` object: Additional MongoDB connection options. - DestinationGa4: Google Analytics 4 is a service offered by Google that reports website traffic data and marketing trends. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'ga4', required - `provisioned` boolean - `testConnectionError` string - `apiSecret` string, required: An API SECRET generated in the Google Analytics UI. To create a new secret, navigate to:
Admin > Data Streams > choose your stream > Measurement Protocol API Secrets > Create - `measurementId` string, required: The measurement ID associated with a stream.
For Web: found in the Google Analytics UI under: Admin > Data Streams > choose your stream > Measurement ID
For Apps: the Firebase App ID, found in the Firebase console under: Project Settings > General > Your Apps > App ID - `events` string: List of events to send, delimited by comma. Following page, screen, or any arbitrary event (name of track event). Special values: empty string - send only track events, * - send all events useful if you want to filter events with Functions - DestinationPosthog: Posthog is an open-source product analytics tool. Jitsu supports both self-hosted Posthog and Posthog Cloud. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'posthog', required - `provisioned` boolean - `testConnectionError` string - `key` string, required: Project API Key::Posthog Project API Key. Can be found in Project Settings - `host` string: Posthog host - `enableGroupAnalytics` boolean: Group analytics is a powerful feature in PostHog that allows you to perform analytics on entities other than single users. Group Analytics is not available on the open-source or free cloud plan. Learn more. - `groupType` string: Group type is the abstract type of whatever our group represents (e.g. company, team, chat, post, etc.). Groups vs. group types. - `sendAnonymousEvents` boolean: Send events from anonymous users. If disabled, only events from identified users will be tracked. - `enableAnonymousUserProfiles` boolean: Enable Anonymous Person Profiles::Create Person profiles for anonymous users. If disabled, only identified users will have profiles. - DestinationAmplitude: Amplitude is a product analytics platform - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'amplitude', required - `provisioned` boolean - `testConnectionError` string - `key` string, required: Project API Key::Amplitude Project API Key. - `enableGroupAnalytics` boolean: Build an analysis around aggregated units of measure like accounts, charts, or order IDs. Requires The Amplitude Accounts add-on. Learn more. - `groupType` string: Group type is the abstract type of whatever our group represents (e.g. accounts, charts, or order IDs). - `enableAnonymousUserProfiles` boolean: If enabled, anonymous users will be tracked in Amplitude - `dataResidency` 'US' | 'EU' - `sessionWindow` number: Session window in minutes - `minIdLength` number: Minimum ID Length::Overrides the Amplitude's default minimum ID length of 5 characters. - DestinationStatsig: Statsig is a feature management, experimentation, and product analytics platform - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'statsig', required - `provisioned` boolean - `testConnectionError` string - `apiKey` string, required: Server Secret Key::Server Secret Key. Server Secret Keys can be created in Statsig Console → Project Settings → Keys & Environments. - `enableAnonymousUserProfiles` boolean: If enabled, anonymous users (without userId) will be tracked in Statsig using their anonymousId - `sendPageEvents` boolean: If enabled, page and screen view events will be sent to Statsig - `segmentCompatibility` boolean: Segment Compatibility Mode::When enabled, customIDs and custom properties will only be populated from statsigCustomIDs and statsigCustom arrays in event properties or traits, following Segment's integration pattern. Arrays should be in key-value pair format: ["key1", "value1", "key2", "value2"]. - `includeContextInMetadata` boolean: Include Context in Metadata::When enabled, event context properties (page, screen, device, etc.) will be included in event metadata. - `environment` string: Environment Tier::Statsig environment tier (e.g., production, staging, development). This will be used to segment data by environment in Statsig. - DestinationHubspot: Hubspot is a CRM. Jitsu sends data to Hubspot API and updates contacts and company records - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'hubspot', required - `provisioned` boolean - `testConnectionError` string - `accessToken` string, required: To obtain an access secret, go to Settings » Account Setup » Private Apps, create a new private app copy the Access token. See detailed guide. Please make sure to grant an application all read and write permissions under CRM section - `sendPageViewEvents` boolean: When enabled, Jitsu will send page view events to hubspot (only events with a known email) - `autoCreateCustomProperties` boolean: When enabled, Jitsu will automatically create HubSpot custom properties for Contacts and Companies to capture every new trait. Otherwise, only known properties are sent. - DestinationDevnull: This destination does not send any data anywhere. However, you can connect a function to this destination - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'devnull', required - `provisioned` boolean - `testConnectionError` string - DestinationSegmentProxy: Base shape shared by every destination type. Concrete subtypes (DestinationPostgres, DestinationClickhouse, etc.) extend this with type-specific credentials. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'segment-proxy', required - `provisioned` boolean - `testConnectionError` string - `apiBase` 'https://api.segmentapis.com/v1' | 'https://eu1.api.segmentapis.com/v1' | 'https://api.segment.io/v1': API Base::Segment API Base - `writeKey` string, required: To get an API Key you need to add the HTTP API source to your Segment workspace. Write Key can be found on the HTTP API source Overview page. - DestinationWebhook: Send data to any HTTP endpoint. You can use this destination to send data to Slack, Discord, or any other service that accepts HTTP requests. Requests can optionally be signed (HMAC-SHA256 or Ed25519) so your endpoint can verify their authenticity. - `id` string, required - `type` string, required - `workspaceId` string, required - `name` string, required - `updatedAt` string, nullable - `cloneId` string - `destinationType` 'webhook', required - `provisioned` boolean - `testConnectionError` string - `url` string, uri, required: Webhook URL - `method` 'GET' | 'POST' | 'PUT' | 'DELETE': HTTP method. Can be GET, POST, PUT, DELETE - `headers` string[]: List of headers in format key: value - `customPayload` boolean: Enable custom payload. If disabled, the event payload will be sent as is. - `payload` string: Payload Template::Template for the webhook payload. The following macros are supported: - `signatureMethod` 'none' | 'hmac' | 'ed25519': Signature Method::How outgoing requests are signed so your endpoint can verify them.Note: signing applies to stream-mode delivery only. In batch mode events are delivered by Bulker and are not signed — use stream mode if you need signed webhooks. - `signatureSecret` string: Signing Secret::Shared secret for HMAC-SHA256 signing (symmetric — there is no key pair). Put the same value here and in your receiving endpoint. Generate a random one with openssl rand -hex 32 (any high-entropy string of 32+ bytes works). To verify a request, your endpoint recomputes the HMAC over the signed payload with this secret and compares the hex digest to the Jitsu-Signature header using a constant-time comparison. Keep it secret. - `signaturePrivateKey` string: Private Key (PEM)::Ed25519 private key used to sign requests. Generate a key pair:
openssl genpkey -algorithm ed25519 -out jitsu_private.pem
openssl pkey -in jitsu_private.pem -pubout -out jitsu_public.pem
Paste the contents of jitsu_private.pem here and install jitsu_public.pem on your endpoint. To verify a request, your endpoint checks the Jitsu-Signature header (a hex Ed25519 signature) against the signed payload using the public key. Jitsu holds only the private key — keep it secret; the public key is safe to distribute. - `signatureHeader` string: Signature Header::Name of the header carrying the signature. Only used when signing is enabled. - `signatureIncludeTimestamp` boolean: Replay Protection::When enabled (recommended), the request timestamp (unix seconds) is folded into the signed payload — the signature covers <timestamp>.<body> — and sent in a companion <Signature Header>-Timestamp header. Your endpoint can then reject requests with an old timestamp to block replays of a captured, still-valid request. When disabled, only the raw body is signed and no timestamp header is sent: simpler to verify, but a captured request stays valid forever. Only used when signing is enabled. ## Other responses - `400`: Bad request - `401`: Authorization required - `403`: Forbidden — no access to this workspace, or the workspace's plan does not include this feature - `500`: Internal server error --- [API](https://skmtc.dev/jitsu/apis/jitsu-api.md) - [All operations](https://skmtc.dev/jitsu/apis/jitsu-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jitsu/apis/jitsu-api/revisions/f6b8702d246f?raw)