Create a destination
このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。
Always creates a new destination; the server assigns the id used for
every subsequent lookup. display_name is not an identity key, so
repeating a create makes another destination. When dry_run=true, returns
a plan envelope without mutating. Credential config (secret, OAuth,
service account, custom HTTP header, ads account, and encrypted text)
is write-only and omitted from the response.
/v1/projects/{project_id}/destinationsAuthorizations
Authorizationstringrequiredhttp
Path parameters
project_idstringrequiredAmplitude project identifier, backed by the canonical app ID.
12345pattern: ^[0-9]+$Query parameters
dry_runbooleanValidate request without performing mutation.
falseBody
application/jsonpartnerstringrequireddisplay_namestringrequiredmin length: 1kindstring[]Optional connector kinds. When omitted, the kind is inferred from the partner's capabilities; a multi-capability partner with no kind is rejected as ambiguous. When provided it is authoritative and validated against the partner. The three families are mutually exclusive: a subset of [event, identify], or [cohort], or [warehouse_export] — never combined.
event_filterobjectShow child attributes
eventsstring[]requiredproperty_filtersobjectconfigobjectenabledbooleanproperty_mappingsobjectsend_eventsbooleansend_usersbooleanResponse
application/jsondataobjectrequiredShow child attributes
idstringrequiredServer-assigned identifier (read-only).
objectstringrequiredproject_idstringrequiredpattern: ^[0-9]+$partnerstringrequireddisplay_namestringrequiredkindstring[]requiredconfigobjectrequiredPartner config keyed by parameter id. Reads return an allowlist of non-credential types: string, boolean, enum, mapped field, event mapping, and transformation. Secret, OAuth, service-account, custom HTTP header, and ads-account values are write-only and never returned. A string flagged shouldEncryptInDb is omitted too. Structured values round-trip as decoded JSON.
credential_statusstringrequiredconnecteddisconnectedexpiredversionintegerrequiredmin: 1enabledbooleanEvent-streaming only. Whether the stream is enabled.
pausedbooleanEvent-streaming only. Whether the stream is paused.
event_filteroneOfEvent-streaming only. Events (and optional property filters) to stream.
objectnulleventsstring[]property_filtersobjectproperty_mappingsoneOfEvent-streaming only. Optional property mappings.
objectnullsend_eventsbooleanEvent-streaming only. Whether to send events.
send_usersbooleanEvent-streaming only. Whether to send identify/user updates.
created_atstringrequiredformat: date-timeupdated_atstringrequiredformat: date-timecreated_bystringnullableupdated_bystringnullableplanobjectrequiredShow child attributes
actionstringrequiredcreateupdatenoopdry_runbooleanrequireddiffoneOfobjectnullwarningsstring[]dataobjectrequiredShow child attributes
idstringrequiredServer-assigned identifier (read-only).
objectstringrequiredproject_idstringrequiredpattern: ^[0-9]+$partnerstringrequireddisplay_namestringrequiredkindstring[]requiredconfigobjectrequiredPartner config keyed by parameter id. Reads return an allowlist of non-credential types: string, boolean, enum, mapped field, event mapping, and transformation. Secret, OAuth, service-account, custom HTTP header, and ads-account values are write-only and never returned. A string flagged shouldEncryptInDb is omitted too. Structured values round-trip as decoded JSON.
credential_statusstringrequiredconnecteddisconnectedexpiredversionintegerrequiredmin: 1enabledbooleanEvent-streaming only. Whether the stream is enabled.
pausedbooleanEvent-streaming only. Whether the stream is paused.
event_filteroneOfEvent-streaming only. Events (and optional property filters) to stream.
objectnulleventsstring[]property_filtersobjectproperty_mappingsoneOfEvent-streaming only. Optional property mappings.
objectnullsend_eventsbooleanEvent-streaming only. Whether to send events.
send_usersbooleanEvent-streaming only. Whether to send identify/user updates.
created_atstringrequiredformat: date-timeupdated_atstringrequiredformat: date-timecreated_bystringnullableupdated_bystringnullableこれは役に立ちましたか?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.