From 7ce9d32e877b8362d1696a0dc0e6bc745097fa40 Mon Sep 17 00:00:00 2001 From: Max Strelnikov Date: Mon, 21 Nov 2022 13:24:16 +0200 Subject: [PATCH 1/5] Added documentation for Actions Pipedrive --- .../destinations/catalog/pipedrive/index.md | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 src/connections/destinations/catalog/pipedrive/index.md diff --git a/src/connections/destinations/catalog/pipedrive/index.md b/src/connections/destinations/catalog/pipedrive/index.md new file mode 100644 index 0000000000..e8546cd103 --- /dev/null +++ b/src/connections/destinations/catalog/pipedrive/index.md @@ -0,0 +1,52 @@ +--- +title: Actions Pipedrive +hide-boilerplate: true +hide-dossier: true +--- + +{% include content/plan-grid.md name="actions" %} + +The Actions Pipedrive destination is an integration that allows customers to share events from Segment directly to Pipedrive. +When you use Pipedrive with Segment, you don’t need to manually export and upload data to Pipedrive. Your customer data will remain up to date in real time and across all enabled integrations. +Every tool you use to interact with leads and customers will land in Pipedrive, so you can always have a clear picture in front of you. + +{% include content/ajs-upgrade.md %} + +## Benefits of Actions Pipedrive + +Actions Pipedrive provides the following benefits: + +- **Clear mapping of data**. Actions-based destinations enable you to define the mapping between the data Segment receives from your source and the data Segment sends to Pipedrive. +- **Maximum event measurement**. Capture more events with improved accuracy across different browsers, apps, and devices to get a unified view of your customer’s journey from page view to purchase. + +## Getting started + +1. From the Segment web app, click **Catalog**, then click **Destinations**. +2. Find the Destinations Actions item in the left navigation, and click it. +3. Click **Configure "Actions Pipedrive"**. +4. Select an existing Source to connect to "Actions Pipedrive". +5. When adding Pipedrive as a destination, you will be redirected to the basic settings page, where you need to enter the destination name as well as Pipedrive's domain and API token. +6. To complete the installation process, switch to advanced settings and enter your Pipedrive IDs. + +To set up the Segment integration with your Pipedrive account, go to either your Marketplace menu within your settings or directly to Pipedrive's Marketplace. +From there, search for Segment and click on "Install now" +A new window will pop up and prompt you to allow Segment to connect with Pipedrive. +Choose the Pipedrive account you wish to connect to. Then, click "Allow and Install". +Once the installation is successful, you will be redirected to Segment for account authentication. + +{% include components/actions-fields.html %} + +## Available Actions +Build your own Mappings! Combine supported triggers with the following Pipedrive -supported actions: +- **Create or update a person** +- **Create or update an activity** +- **Create or update a lead** +- **Create or update a note** +- **Create or update a deal** +- **Create or update an organization**. + +### Identify +Segment sends Identify calls to Pipedrive as an identify event. When you identify a new user, Pipedrive creates a new User or Company. If the Use or Company already exists, Pipedrive updates the properties. + +### Track +Segment sends Track calls to Pipedrive as a track event. They can be used in Pipedrive as event sources. You can create an Activity, or update Custom Fields or store it in the notes for the Deals or create/update the Deal. From 286a46638c0dbf6ee2b53b8a486a89bc0a356e24 Mon Sep 17 00:00:00 2001 From: stayseesong Date: Mon, 21 Nov 2022 14:44:22 -0800 Subject: [PATCH 2/5] fixes --- .../destinations/catalog/pipedrive/index.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/connections/destinations/catalog/pipedrive/index.md b/src/connections/destinations/catalog/pipedrive/index.md index e8546cd103..2463ab48eb 100644 --- a/src/connections/destinations/catalog/pipedrive/index.md +++ b/src/connections/destinations/catalog/pipedrive/index.md @@ -6,9 +6,7 @@ hide-dossier: true {% include content/plan-grid.md name="actions" %} -The Actions Pipedrive destination is an integration that allows customers to share events from Segment directly to Pipedrive. -When you use Pipedrive with Segment, you don’t need to manually export and upload data to Pipedrive. Your customer data will remain up to date in real time and across all enabled integrations. -Every tool you use to interact with leads and customers will land in Pipedrive, so you can always have a clear picture in front of you. +The Actions Pipedrive destination is an integration that allows customers to share events from Segment directly to Pipedrive. When you use Pipedrive with Segment, you don’t need to manually export and upload data to Pipedrive. Your customer data will remain up to date in real time and across all enabled integrations. Every tool you use to interact with leads and customers will land in Pipedrive, so you can always have a clear picture in front of you. {% include content/ajs-upgrade.md %} @@ -28,11 +26,13 @@ Actions Pipedrive provides the following benefits: 5. When adding Pipedrive as a destination, you will be redirected to the basic settings page, where you need to enter the destination name as well as Pipedrive's domain and API token. 6. To complete the installation process, switch to advanced settings and enter your Pipedrive IDs. -To set up the Segment integration with your Pipedrive account, go to either your Marketplace menu within your settings or directly to Pipedrive's Marketplace. -From there, search for Segment and click on "Install now" -A new window will pop up and prompt you to allow Segment to connect with Pipedrive. -Choose the Pipedrive account you wish to connect to. Then, click "Allow and Install". -Once the installation is successful, you will be redirected to Segment for account authentication. +To set up the Segment integration with your Pipedrive account: +1. Go to either your Marketplace menu within your settings or directly to Pipedrive's Marketplace. +2. Search for *Segment* and click on **Install now**. +3. A new window will pop up and prompt you to allow Segment to connect with Pipedrive. +4. Choose the Pipedrive account you wish to connect to, then, click **Allow and Install**. + +Once the installation is successful, you'll be redirected to Segment to authenticate your account. {% include components/actions-fields.html %} @@ -46,7 +46,7 @@ Build your own Mappings! Combine supported triggers with the following Pipedrive - **Create or update an organization**. ### Identify -Segment sends Identify calls to Pipedrive as an identify event. When you identify a new user, Pipedrive creates a new User or Company. If the Use or Company already exists, Pipedrive updates the properties. +Segment sends Identify calls to Pipedrive as an identify event. When you identify a new user, Pipedrive creates a new User or Company. If the User or Company already exists, Pipedrive updates the properties. ### Track Segment sends Track calls to Pipedrive as a track event. They can be used in Pipedrive as event sources. You can create an Activity, or update Custom Fields or store it in the notes for the Deals or create/update the Deal. From d379ef83e2611431bad8c5e73157948f31a16684 Mon Sep 17 00:00:00 2001 From: stayseesong Date: Mon, 21 Nov 2022 18:04:37 -0800 Subject: [PATCH 3/5] vale --- vale-styles/Vocab/Docs/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/vale-styles/Vocab/Docs/accept.txt b/vale-styles/Vocab/Docs/accept.txt index 4187b0a359..b827114c4e 100644 --- a/vale-styles/Vocab/Docs/accept.txt +++ b/vale-styles/Vocab/Docs/accept.txt @@ -74,6 +74,7 @@ Omnichannel onboarding Optimizely performant +Pipedrive Preact Shopify Skalin From fbadc4fab3ff53534e4c047d1f4125ced1d81164 Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Mon, 28 Nov 2022 10:25:11 -0800 Subject: [PATCH 4/5] Add metadata --- .github/styles/Vocab/Docs/accept.txt | 1 + src/_data/catalog/destinations_private.yml | 1509 ++++++++++++++--- .../destinations/catalog/pipedrive/index.md | 2 + 3 files changed, 1291 insertions(+), 221 deletions(-) diff --git a/.github/styles/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt index b017f3986e..81f6e27142 100644 --- a/.github/styles/Vocab/Docs/accept.txt +++ b/.github/styles/Vocab/Docs/accept.txt @@ -114,6 +114,7 @@ Pardot Passcode performant Pinterest +Pipedrive Preact Qualtrics reformat(:?s) diff --git a/src/_data/catalog/destinations_private.yml b/src/_data/catalog/destinations_private.yml index 6cb0f25a4b..e22cc22a97 100644 --- a/src/_data/catalog/destinations_private.yml +++ b/src/_data/catalog/destinations_private.yml @@ -1,212 +1,6 @@ # AUTOGENERATED FROM PUBLIC API. DO NOT EDIT -# destination data last updated 2022-11-17 +# destination data last updated 2022-11-28 items: - - id: 62b256147cbb49302d1486d0 - display_name: Heap Web (Actions) - name: Heap Web (Actions) - slug: actions-heap-web - previous_names: - - Heap Web (Actions) - website: https://heap.io/ - status: PRIVATE_BETA - logo: - url: https://cdn.filepicker.io/api/file/3MfYsCdgQhu8cVRSPKE6 - mark: - url: https://cdn.filepicker.io/api/file/eniQdenRhmxHsstAJUxw - methods: - track: true - pageview: true - identify: true - group: true - alias: true - platforms: - browser: true - mobile: false - server: false - components: [] - browserUnbundlingSupported: false - browserUnbundlingPublic: false - replay: false - settings: - - name: clevertapAccountId - type: string - defaultValue: '' - description: >- - CleverTap Account Id. This can be found under [Settings - Page](https://developer.clevertap.com/docs/authentication#getting-your-account-credentials). - required: true - label: CleverTap Account ID - - name: clevertapEndpoint - type: select - defaultValue: https://sk1.api.clevertap.com - description: >- - Learn More about [Account - regions](https://docs.clevertap.com/docs/build-segment-destination#set-up-segment-destination-action). - required: true - label: REST Endpoint - - name: clevertapPasscode - type: string - defaultValue: '' - description: >- - CleverTap Passcode. This can be found under [Settings - Page](https://developer.clevertap.com/docs/authentication#getting-your-account-credentials). - required: true - label: CleverTap Account Passcode - actions: - - id: e3Sy9jMKUfuTSHk6ebh6fb - name: User Upload - slug: userUpload - description: >- - The User Upload Action enables you to create or update user profiles - in CleverTap. - platform: CLOUD - hidden: false - defaultTrigger: null - fields: - - id: riruCuyy2tVDVz8XrawGjN - sortOrder: 0 - fieldKey: ts - label: Created At - type: STRING - description: A timestamp when the person was created - placeholder: '' - defaultValue: - '@path': $.timestamp - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: tHVUT8H3vNkrfd7aJWxVzk - sortOrder: 1 - fieldKey: profileData - label: Person Attributes - type: OBJECT - description: >- - Optional attributes for the person. When updating a person - attributes added or updated, not removed - placeholder: '' - defaultValue: - '@path': $.properties - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - - id: wVrVgyTGvrjD6VF7PGShw9 - sortOrder: 2 - fieldKey: identity - label: Identity - type: STRING - description: The Id used to uniquely identify a person in CleverTap - placeholder: '' - defaultValue: - '@path': $.userId - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: uXV6Z1775w9WKaEFjpzU4g - name: User Delete - slug: userDelete - description: >- - The User Delete Action enables you to remove user profiles in - CleverTap. - platform: CLOUD - hidden: false - defaultTrigger: null - fields: - - id: xaSMDsUdxZ1KtoUZSoRic1 - sortOrder: 0 - fieldKey: identity - label: Identity - type: STRING - description: The ID used to uniquely identify a person in CleverTap - placeholder: '' - defaultValue: - '@path': $.userId - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - presets: [] - - id: 6372e18fb2b3d5d741c34bb6 - display_name: Sabil - name: Sabil - slug: actions-sabil - previous_names: - - Sabil - website: https://sabil.io - status: PRIVATE_BETA - logo: - url: https://cdn.filepicker.io/api/file/ipyYsLT3uqnwf73emDTw - mark: - url: https://cdn.filepicker.io/api/file/UwIMXDcQXuq8basSngRb - methods: - track: true - pageview: true - identify: true - group: true - alias: true - platforms: - browser: true - mobile: false - server: false - components: [] - browserUnbundlingSupported: false - browserUnbundlingPublic: false - replay: false - settings: - - name: client_id - type: string - defaultValue: '' - description: >- - Your project API client ID. You can find it in your Sabil - [dashboard](https://dashboard.sabil.io/api_keys) - required: true - label: Client ID - actions: - - id: 4WZBuJdtw6r6tp3Jg9pdjY - name: Attach - slug: attach - description: Attach a device to the user. - platform: WEB - hidden: false - defaultTrigger: type = "identify" - fields: - - id: tWmYutvSR1nQ3ycSog6gRT - sortOrder: 0 - fieldKey: user_id - label: User ID - type: STRING - description: 'The ID of the user ' - placeholder: '' - defaultValue: - '@path': $.userId - required: true - multiple: false - choices: null - dynamic: false - allowNull: false - - id: twhTbpVrwdpPe7C2vg5KzG - sortOrder: 1 - fieldKey: metadata - label: Metadata - type: OBJECT - description: >- - A key-value object that will be stored alongside the user, device - and access records. This will be available to in any webhooks or - API calls. Useful if you want to remote logout a device or - invalidate a session from the backend via webhook. - placeholder: '' - required: false - multiple: false - choices: null - dynamic: false - allowNull: false - presets: [] - id: 62e30bad99f1bfb98ee8ce08 display_name: Salesforce Marketing Cloud (Actions) name: Salesforce Marketing Cloud (Actions) @@ -229,6 +23,7 @@ items: browser: true mobile: false server: true + warehouse: true components: [] browserUnbundlingSupported: false browserUnbundlingPublic: false @@ -532,19 +327,83 @@ items: If true, data is batched before sending to the SFMC Data Extension. placeholder: '' + defaultValue: false + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: [] + - id: 6372e18fb2b3d5d741c34bb6 + display_name: Sabil + name: Sabil + slug: actions-sabil + previous_names: + - Sabil + website: https://sabil.io + status: PRIVATE_BETA + logo: + url: https://cdn.filepicker.io/api/file/ipyYsLT3uqnwf73emDTw + mark: + url: https://cdn.filepicker.io/api/file/UwIMXDcQXuq8basSngRb + methods: + track: true + pageview: true + identify: true + group: true + alias: true + platforms: + browser: true + mobile: false + server: false + warehouse: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + settings: + - name: client_id + type: string + defaultValue: '' + description: >- + Your project API client ID. You can find it in your Sabil + [dashboard](https://dashboard.sabil.io/api_keys) + required: true + label: Client ID + actions: + - id: 4WZBuJdtw6r6tp3Jg9pdjY + name: Attach + slug: attach + description: Attach a device to the user. + platform: WEB + hidden: false + defaultTrigger: type = "identify" + fields: + - id: tWmYutvSR1nQ3ycSog6gRT + sortOrder: 0 + fieldKey: user_id + label: User ID + type: STRING + description: 'The ID of the user ' + placeholder: '' defaultValue: - event: - '@path': $.event - type: - '@path': $.type - userId: - '@path': $.userId - properties: - '@path': $.properties - traits: - '@path': $.traits - context: - '@path': $.context + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: twhTbpVrwdpPe7C2vg5KzG + sortOrder: 1 + fieldKey: metadata + label: Metadata + type: OBJECT + description: >- + A key-value object that will be stored alongside the user, device + and access records. This will be available to in any webhooks or + API calls. Useful if you want to remote logout a device or + invalidate a session from the backend via webhook. + placeholder: '' required: false multiple: false choices: null @@ -570,9 +429,10 @@ items: group: true alias: true platforms: - browser: true + browser: false mobile: false - server: true + server: false + warehouse: true components: [] browserUnbundlingSupported: false browserUnbundlingPublic: false @@ -710,3 +570,1210 @@ items: dynamic: false allowNull: false presets: [] + - id: 5f7dd8191ad74f868ab1fc48 + display_name: Actions Pipedrive + name: Actions Pipedrive + slug: actions-pipedrive + previous_names: + - Actions Pipedrive + website: https://www.pipedrive.com/ + status: PRIVATE_BETA + logo: + url: https://cdn.filepicker.io/api/file/OQigqoPHT56xZCcwgcyT + mark: + url: https://cdn.filepicker.io/api/file/8iu5T30JTWrKKBhZRFw6 + methods: + track: true + pageview: true + identify: true + group: true + alias: true + platforms: + browser: true + mobile: false + server: true + warehouse: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + settings: + - name: apiToken + type: string + defaultValue: '' + description: >- + Pipedrive API token. This is found in Pipedrive in Settings > Personal + preferences > API > Your personal API token. + required: true + label: API Token + - name: dealField + type: string + defaultValue: id + description: >- + This is a key by which a Deal in Pipedrive will be searched. It can be + either Deal id or has of a custom field containing external id. + Default value is `deal_id`. + required: false + label: External ID field for a Deal in Pipedrive + - name: domain + type: string + defaultValue: '' + description: >- + Pipedrive domain. This is found in Pipedrive in Settings > Company + settings > Company domain. + required: true + label: Domain + - name: organizationField + type: string + defaultValue: id + description: >- + This is a key by which an Organization in Pipedrive will be searched. + It can be either Organization id or has of a custom field containing + external id. Default value is `org_id`. + required: false + label: External ID field for an Organization in Pipedrive + - name: personField + type: string + defaultValue: id + description: >- + This is a key by which a Person in Pipedrive will be searched. It can + be either Person id or has of a custom field containing external id. + Default value is `person_id`. + required: false + label: External ID field for a Person in Pipedrive + actions: + - id: 66wGU3cfJrrdBk8CqekrJc + name: Create or Update Person + slug: createUpdatePerson + description: Update a person in Pipedrive or create them if they don't exist yet. + platform: CLOUD + hidden: false + defaultTrigger: type = "identify" + fields: + - id: v8pZBCVAfrg1mUwo8fX575 + sortOrder: 0 + fieldKey: match_field + label: Match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + person in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: 6Zu4zMjevCU8UzPCGSqbaq + sortOrder: 1 + fieldKey: match_value + label: Match value + type: STRING + description: Value to find existing person by + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: i7ApvN1hdihTh8j8FbKX3H + sortOrder: 2 + fieldKey: name + label: Person Name + type: STRING + description: Name of the person + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: r6pcvMZixU9aJzvzCVU2qW + sortOrder: 3 + fieldKey: email + label: Email Address + type: STRING + description: Email addresses for this person. + placeholder: '' + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: tWSH3opTiXMHBkxd3BkFyt + sortOrder: 4 + fieldKey: phone + label: Phone Number + type: STRING + description: Phone numbers for the person. + placeholder: '' + required: false + multiple: true + choices: null + dynamic: false + allowNull: false + - id: 7EaCFJjhyqBF5Ytgggm5so + sortOrder: 5 + fieldKey: visible_to + label: Visible To + type: INTEGER + description: >- + Visibility of the Person. If omitted, visibility will be set to + the default visibility setting of this item type for the + authorized user. + placeholder: '' + required: false + multiple: false + choices: + - label: Owner & followers (private) + value: 1 + - label: Entire company (shared) + value: 3 + dynamic: false + allowNull: false + - id: cHdsAGFtBnv795LsV1KG3k + sortOrder: 6 + fieldKey: add_time + label: Created At + type: DATETIME + description: >- + If the person is created, use this timestamp as the creation + timestamp. Format: YYY-MM-DD HH:MM:SS + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: iKutwojThpoo1xbn4dPrFz + sortOrder: 7 + fieldKey: custom_fields + label: Custom fields + type: OBJECT + description: New values for custom fields. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dGDsZPqKXXCQNrgDcr1oKb + name: Create or update an Activity + slug: createUpdateActivity + description: Update an Activity in Pipedrive or create one if it doesn't exist. + platform: CLOUD + hidden: false + defaultTrigger: type = "track" + fields: + - id: nE8Qhue2hW1fyMjNMnjx8G + sortOrder: 0 + fieldKey: activity_id + label: Activity ID + type: INTEGER + description: >- + ID of Activity in Pipedrive to Update. If left empty, a new one + will be created + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: xxFCsEspF4kTTf1nACS1yd + sortOrder: 1 + fieldKey: person_match_field + label: Person match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + person in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: jDQ2wjvXpwJ8v6Mr3WDs1G + sortOrder: 2 + fieldKey: person_match_value + label: Person match value + type: STRING + description: Value to find existing person by + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 3jo5dqWdjZhFcZRs9NxDqq + sortOrder: 3 + fieldKey: organization_match_field + label: Organization match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + organization in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: 889pNtk3G5MQqDrqJtrHTD + sortOrder: 4 + fieldKey: organization_match_value + label: Organization match value + type: STRING + description: Value to find existing organization by + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mG1GR1sjeXoz5ui2uK97Ho + sortOrder: 5 + fieldKey: deal_match_field + label: Deal match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + deal in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: qRZPSL7qZRmaAwf3KZgFmY + sortOrder: 6 + fieldKey: deal_match_value + label: Deal match value + type: STRING + description: Value to find existing deal by + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 91gmSoJhWNinGrmTjdALrr + sortOrder: 7 + fieldKey: subject + label: Activity Subject + type: STRING + description: >- + Subject of the Activity. When value for subject is not set, it + will be given a default value `Call`. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uoHfnojMcXumX4usxFWCXB + sortOrder: 8 + fieldKey: type + label: Type + type: STRING + description: >- + Type of the Activity. This is in correlation with the key_string + parameter of ActivityTypes. When value for type is not set, it + will be given a default value `Call` + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2kzqrp6XUwbeE8EZVFtxQY + sortOrder: 9 + fieldKey: description + label: Description + type: STRING + description: >- + Additional details about the Activity that is synced to your + external calendar. Unlike the note added to the Activity, the + description is publicly visible to any guests added to the + Activity. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: ieoD3tmstNKWcK9W1ZP6hs + sortOrder: 10 + fieldKey: note + label: Note + type: STRING + description: Note of the Activity (HTML format) + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: j3dV372BNK7ojufxZv3Dpe + sortOrder: 11 + fieldKey: due_date + label: Due Date + type: STRING + description: 'Due date of the Activity. Format: YYYY-MM-DD' + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 6GDPhgauvMaXxiyohETk4s + sortOrder: 12 + fieldKey: due_time + label: Due Time + type: STRING + description: 'Due time of the Activity in UTC. Format: HH:MM' + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: htLho5TZaDMVapAeAnLDHm + sortOrder: 13 + fieldKey: duration + label: Duration + type: STRING + description: 'Duration of the Activity. Format: HH:MM' + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7K2TUGBsZX59KG2CdZGDdE + sortOrder: 14 + fieldKey: done + label: Done + type: BOOLEAN + description: Whether the Activity is done or not. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hd2J84Sw2PcfzEkAm47YaK + name: Create or Update a Lead + slug: createUpdateLead + description: Update a Lead in Pipedrive or create it if it doesn't exist yet. + platform: CLOUD + hidden: false + defaultTrigger: type = "identify" + fields: + - id: 2B3AyMbJXTifGMkSpypcr + sortOrder: 0 + fieldKey: lead_id + label: Lead ID + type: INTEGER + description: >- + ID of Lead in Pipedrive to Update. If left empty, a new one will + be created + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 48nCCfdmFthYXTx7vVaLFr + sortOrder: 1 + fieldKey: person_match_field + label: Person match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + person in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: a7t3WwAcoSs6KEX6dLCSjd + sortOrder: 2 + fieldKey: person_match_value + label: Person match value + type: STRING + description: >- + Value to find existing person by. Required unless + organization_match_value present + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: gy9T3eRSni2t6a4cqBD7DF + sortOrder: 3 + fieldKey: organization_match_field + label: Organization match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + organization in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: 6Uvh6k1FiwaV6ThFG8mGCH + sortOrder: 4 + fieldKey: organization_match_value + label: Organization match value + type: STRING + description: >- + Value to find existing organization by. Required unless + person_match_value present + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jhcL4EwBgffrcTtXqvNiis + sortOrder: 5 + fieldKey: title + label: Title + type: STRING + description: The name of the Lead + placeholder: '' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qqGrZzTVN8R4f5ivTDfxrX + sortOrder: 6 + fieldKey: value + label: Value + type: OBJECT + description: Potential value of the lead + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: z34ojMGnovdMrsPvVqpoE + sortOrder: 7 + fieldKey: expected_close_date + label: Expected Close Date + type: STRING + description: >- + The date of when the Deal which will be created from the Lead is + expected to be closed. In ISO 8601 format: YYYY-MM-DD. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: x81VmHGr61HRsnij9jd16T + sortOrder: 8 + fieldKey: visible_to + label: Visible To + type: INTEGER + description: >- + Visibility of the Lead. If omitted, visibility will be set to the + default visibility setting of this item type for the authorized + user. + placeholder: '' + required: false + multiple: false + choices: + - label: Owner & followers (private) + value: 1 + - label: Entire company (shared) + value: 3 + dynamic: false + allowNull: false + - id: gAUjBmjW9b8BSQhyCyiXYv + sortOrder: 9 + fieldKey: add_time + label: Created At + type: DATETIME + description: >- + If the lead is created, use this timestamp as the creation + timestamp. Format: YYY-MM-DD HH:MM:SS + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: rR7Bu92sh7hoRhHeY2qXwa + sortOrder: 10 + fieldKey: custom_fields + label: Custom fields + type: OBJECT + description: New values for custom fields. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: qGniQ3jn3aUkXmCmzkM2RN + name: Create or Update a Note + slug: createUpdateNote + description: Update a Note in Pipedrive or create it if it doesn't exist yet. + platform: CLOUD + hidden: false + defaultTrigger: type = "track" + fields: + - id: 7KCq3gLLVBxPzfQQY8M3zr + sortOrder: 0 + fieldKey: note_id + label: Note ID + type: INTEGER + description: >- + ID of Note in Pipedrive to Update. If left empty, a new one will + be created + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2VnmfuMQVLmRRUEwQuzSfV + sortOrder: 1 + fieldKey: lead_id + label: Lead ID + type: INTEGER + description: >- + ID of Lead in Pipedrive to link to. One of Lead, Person, + Organization or Deal must be linked! + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: aqDHMBf5AmaNFJ8RAgEfbD + sortOrder: 2 + fieldKey: person_match_field + label: Person match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + person in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: 6Z6jYwA9uihBFvBmYw5h5W + sortOrder: 3 + fieldKey: person_match_value + label: Person match value + type: STRING + description: >- + Value to find existing person by. One of Lead, Person, + Organization or Deal must be linked! + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7kaynF1i9sPnew6CQ4AqDY + sortOrder: 4 + fieldKey: organization_match_field + label: Organization match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + organization in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: 7PPphSkzqwNLeN8j3ekHRr + sortOrder: 5 + fieldKey: organization_match_value + label: Organization match value + type: STRING + description: >- + Value to find existing organization by. One of Lead, Person, + Organization or Deal must be linked! + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: aiSD2BPug7zSneykECHgp + sortOrder: 6 + fieldKey: deal_match_field + label: Deal match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + deal in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: 2T5Vvfei3RPUhku8g2Ckqu + sortOrder: 7 + fieldKey: deal_match_value + label: Deal match value + type: STRING + description: >- + Value to find existing deal by. One of Lead, Person, Organization + or Deal must be linked! + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 61KgkmwfABhUYi8H1Nzd2B + sortOrder: 8 + fieldKey: content + label: Note Content + type: STRING + description: >- + Content of the note in HTML format. Subject to sanitization on the + back-end. + placeholder: '' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: sHeYJxo1R6dwzgH9koDgZy + name: Create or Update a Deal + slug: createUpdateDeal + description: Update a Deal in Pipedrive or create it if it doesn't exist yet. + platform: CLOUD + hidden: false + defaultTrigger: type = "track" + fields: + - id: j4qCDjihnKhCBknZGm3bSE + sortOrder: 0 + fieldKey: deal_match_field + label: Deal match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + deal in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: gEZ7G6fd9rqfZ31CFsiyB5 + sortOrder: 1 + fieldKey: deal_match_value + label: Deal match value + type: STRING + description: Value to find existing deal by + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hkr4x7riPPnAw9Kja5PY5W + sortOrder: 2 + fieldKey: person_match_field + label: Person match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + person in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: nxCNCW5kZ4kjHRYwSqTzSb + sortOrder: 3 + fieldKey: person_match_value + label: Person match value + type: STRING + description: >- + Value to find existing person by. Required unless + organization_match_value present + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7hvejtEFj9FJpYjmK2LFMj + sortOrder: 4 + fieldKey: organization_match_field + label: Organization match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + organization in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: wsSGEDt7jq6C3XKgWCP1Mz + sortOrder: 5 + fieldKey: organization_match_value + label: Organization match value + type: STRING + description: >- + Value to find existing organization by. Required unless + person_match_value present + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jBfxYdLkyeq8ty1YG9Cjmw + sortOrder: 6 + fieldKey: title + label: Title + type: STRING + description: Deal title (required for new Leads) + placeholder: '' + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: gkLGtc3qTDVzmYqv46S4if + sortOrder: 7 + fieldKey: value + label: Value + type: STRING + description: Value of the deal. If omitted, value will be set to 0. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 2paEGmuETKptmebiHLUPdy + sortOrder: 8 + fieldKey: currency + label: Currency + type: STRING + description: >- + Currency of the deal. Accepts a 3-character currency code. If + omitted, currency will be set to the default currency of the + authorized user. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: jm18vSxbAnoVj2crQk4hWr + sortOrder: 9 + fieldKey: stage_id + label: Stage ID + type: NUMBER + description: >- + The ID of a stage this Deal will be placed in a pipeline (note + that you can't supply the ID of the pipeline as this will be + assigned automatically based on stage_id). If omitted, the deal + will be placed in the first stage of the default pipeline. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uwkmHDHjjwFxHMxtw2jdNL + sortOrder: 10 + fieldKey: status + label: Status + type: STRING + description: >- + Deal status - open, won, lost or deleted. If omitted, status will + be set to open. + placeholder: '' + required: false + multiple: false + choices: + - label: Open + value: open + - label: Won + value: won + - label: Lost + value: lost + - label: Deleted + value: deleted + dynamic: false + allowNull: false + - id: mBAEFEecvFPW19vzcddXmf + sortOrder: 11 + fieldKey: expected_close_date + label: Expected Close Date + type: STRING + description: >- + The expected close date of the Deal. In ISO 8601 format: + YYYY-MM-DD. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4ErVZxX5dVeTbEF8nYsRhZ + sortOrder: 12 + fieldKey: probability + label: Success Probability + type: NUMBER + description: >- + Deal success probability percentage. Used/shown only when + deal_probability for the pipeline of the deal is enabled. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 9ioaT5HcynFnXtjCM9FH1S + sortOrder: 13 + fieldKey: lost_reason + label: Lost Reason + type: STRING + description: >- + Optional message about why the deal was lost (to be used when + status=lost) + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dhRd1262Ux4A4ApU8PU2pb + sortOrder: 14 + fieldKey: visible_to + label: Visible To + type: INTEGER + description: "Visibility of the deal. If omitted, visibility will be set to the default visibility setting of this item type for the authorized user. 1 -Owner & followers (private), 3\t- Entire company (shared)" + placeholder: '' + required: false + multiple: false + choices: + - label: Owner & followers (private) + value: 1 + - label: Entire company (shared) + value: 3 + dynamic: false + allowNull: false + - id: 9HEa3fqExqQQv58LX14meN + sortOrder: 15 + fieldKey: add_time + label: Created At + type: DATETIME + description: >- + If the deal is created, use this timestamp as the creation + timestamp. Format: YYY-MM-DD HH:MM:SS + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 4DYhKzbA94kbguCbhQLHuK + sortOrder: 16 + fieldKey: custom_fields + label: Custom fields + type: OBJECT + description: New values for custom fields. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: uVzPR9SSpfLqF3zoPok99Q + name: Create or Update Organization + slug: createUpdateOrganization + description: >- + Update an organization in Pipedrive or create it if it doesn't exist + yet. + platform: CLOUD + hidden: false + defaultTrigger: type = "group" + fields: + - id: 7vwninmEYYSLuxYSey2qY9 + sortOrder: 0 + fieldKey: match_field + label: Match field + type: STRING + description: >- + If present, used instead of field in settings to find existing + organization in Pipedrive. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: true + allowNull: false + - id: xb9DEfTqdf7nNUeeDHCNzX + sortOrder: 1 + fieldKey: match_value + label: Match value + type: STRING + description: Value to find existing organization by + placeholder: '' + defaultValue: + '@path': $.userId + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: 7awNxJALB3eFYJHeG6fS3R + sortOrder: 2 + fieldKey: name + label: Organization Name + type: STRING + description: Name of the organization + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: dRkokrgXJP8EqPuBUH6omD + sortOrder: 3 + fieldKey: visible_to + label: Visible To + type: INTEGER + description: >- + Visibility of the Organization. If omitted, visibility will be set + to the default visibility setting of this item type for the + authorized user. + placeholder: '' + required: false + multiple: false + choices: + - label: Owner & followers (private) + value: 1 + - label: Entire company (shared) + value: 3 + dynamic: false + allowNull: false + - id: 9DVgCPpZgowvyRxggeEfg7 + sortOrder: 4 + fieldKey: add_time + label: Created At + type: DATETIME + description: >- + If the organization is created, use this timestamp as the creation + timestamp. Format: YYY-MM-DD HH:MM:SS + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: j43CrM6rvwEAi3235ACprQ + sortOrder: 5 + fieldKey: custom_fields + label: Custom fields + type: OBJECT + description: New values for custom fields. + placeholder: '' + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: [] + - id: 62b256147cbb49302d1486d0 + display_name: Heap Web (Actions) + name: Heap Web (Actions) + slug: actions-heap-web + previous_names: + - Heap Web (Actions) + website: https://heap.io/ + status: PRIVATE_BETA + logo: + url: https://cdn.filepicker.io/api/file/3MfYsCdgQhu8cVRSPKE6 + mark: + url: https://cdn.filepicker.io/api/file/eniQdenRhmxHsstAJUxw + methods: + track: true + pageview: true + identify: true + group: true + alias: true + platforms: + browser: true + mobile: false + server: false + warehouse: true + components: [] + browserUnbundlingSupported: false + browserUnbundlingPublic: false + replay: false + settings: + - name: appId + type: string + defaultValue: '' + description: >- + The app ID of the environment to which you want to send data. You can + find this ID on the + [Projects](https://heapanalytics.com/app/manage/projects) page. + required: true + label: Heap app ID + - name: disableTextCapture + type: boolean + defaultValue: false + description: >- + Setting to true will redact all target text on your website. For more + information visit the heap [docs + page](https://developers.heap.io/docs/web#global-data-redaction-via-disabling-text-capture). + required: false + label: Global data redaction via Disabling Text Capture + - name: secureCookie + type: boolean + defaultValue: false + description: >- + This option is turned off by default to accommodate websites not + served over HTTPS. If your application uses HTTPS, we recommend + enabling secure cookies to prevent Heap cookies from being observed by + unauthorized parties. For more information visit the heap [docs + page](https://developers.heap.io/docs/web#securecookie). + required: false + label: Secure Cookie + actions: + - id: 9DNev5M9FhK634qd8TtqXN + name: Identify User + slug: identifyUser + description: Sets user identity + platform: WEB + hidden: false + defaultTrigger: type = "identify" + fields: + - id: aFcado7WC7fAAmth74Qrhx + sortOrder: 0 + fieldKey: userId + label: Identity + type: STRING + description: The user's identity + placeholder: '' + defaultValue: + '@path': $.userId + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: w7z6gUcm8QVF2pWUtUzqa8 + sortOrder: 1 + fieldKey: traits + label: Traits + type: OBJECT + description: The Segment traits to be forwarded to Heap + placeholder: '' + defaultValue: + '@path': $.traits + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + - id: hbxtT8G3frRQvjM6AoJ73p + name: Track Event + slug: trackEvent + description: Track events + platform: WEB + hidden: false + defaultTrigger: type = "track" + fields: + - id: qbPz8kfSwRSSuDNyd85CHg + sortOrder: 0 + fieldKey: name + label: Name + type: STRING + description: The name of the event. + placeholder: '' + defaultValue: + '@path': $.event + required: true + multiple: false + choices: null + dynamic: false + allowNull: false + - id: mSD7ZxZJ44LWttkJAYQYT3 + sortOrder: 1 + fieldKey: properties + label: Properties + type: OBJECT + description: >- + A JSON object containing additional information about the event + that will be indexed by Heap. + placeholder: '' + defaultValue: + '@path': $.properties + required: false + multiple: false + choices: null + dynamic: false + allowNull: false + presets: + - actionId: 9DNev5M9FhK634qd8TtqXN + name: Identify User + fields: + userId: + '@path': $.userId + traits: + '@path': $.traits + trigger: type = "identify" + - actionId: hbxtT8G3frRQvjM6AoJ73p + name: Track Event + fields: + name: + '@path': $.event + properties: + '@path': $.properties + trigger: type = "track" diff --git a/src/connections/destinations/catalog/pipedrive/index.md b/src/connections/destinations/catalog/pipedrive/index.md index 2463ab48eb..712711cc69 100644 --- a/src/connections/destinations/catalog/pipedrive/index.md +++ b/src/connections/destinations/catalog/pipedrive/index.md @@ -2,6 +2,8 @@ title: Actions Pipedrive hide-boilerplate: true hide-dossier: true +id: 5f7dd8191ad74f868ab1fc48 +private: true --- {% include content/plan-grid.md name="actions" %} From f967858ac8da9365eb154b84af139cd701bdcc42 Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Mon, 28 Nov 2022 10:25:46 -0800 Subject: [PATCH 5/5] Remove hardcoded action details [netlify-build] --- .../destinations/catalog/pipedrive/index.md | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/src/connections/destinations/catalog/pipedrive/index.md b/src/connections/destinations/catalog/pipedrive/index.md index 712711cc69..bb58c05f6c 100644 --- a/src/connections/destinations/catalog/pipedrive/index.md +++ b/src/connections/destinations/catalog/pipedrive/index.md @@ -38,17 +38,4 @@ Once the installation is successful, you'll be redirected to Segment to authenti {% include components/actions-fields.html %} -## Available Actions -Build your own Mappings! Combine supported triggers with the following Pipedrive -supported actions: -- **Create or update a person** -- **Create or update an activity** -- **Create or update a lead** -- **Create or update a note** -- **Create or update a deal** -- **Create or update an organization**. - -### Identify -Segment sends Identify calls to Pipedrive as an identify event. When you identify a new user, Pipedrive creates a new User or Company. If the User or Company already exists, Pipedrive updates the properties. - -### Track -Segment sends Track calls to Pipedrive as a track event. They can be used in Pipedrive as event sources. You can create an Activity, or update Custom Fields or store it in the notes for the Deals or create/update the Deal. +