|
| 1 | +--- |
| 2 | +title: Ironclad (Actions) Destination |
| 3 | +hide-boilerplate: true |
| 4 | +hide-dossier: true |
| 5 | +hidden: true |
| 6 | +private: true |
| 7 | +id: 63c874d328bd6bd1aa1f90a0 |
| 8 | +--- |
| 9 | + |
| 10 | + |
| 11 | +{% include content/plan-grid.md name="actions" %} |
| 12 | + |
| 13 | +[Ironclad](https://ironcladapp.com/product/clickwrap/){:target="_blank"} Ironclad Clickwrap is the fastest, easiest way to gather a legally binding digital acceptance, helping forward-thinking companies manage high-volume contracts like terms & conditions, NDAs, and more. |
| 14 | + |
| 15 | +Ironclad maintains this destination. Contact [[email protected]](mailto:[email protected]) with any questions. |
| 16 | + |
| 17 | + |
| 18 | +{% include content/ajs-upgrade.md %} |
| 19 | + |
| 20 | +## Benefits of Ironclad Clickwrap (Actions) |
| 21 | + |
| 22 | +Ironclad (Actions) provides the following benefits: |
| 23 | + |
| 24 | +- **Compliance that’s setup without code** - Configure a simple set of options to start tracking acceptance of [clickwrap agreements](https://ironcladapp.com/product/clickwrap/){:target="_blank"} in Ironclad Clickwrap. |
| 25 | +- **Control what data is tracked** - Map data that Segment receives from your sources, and send the right data to form an enforceable contract in Ironclad. |
| 26 | +- **Connect key user activities to events legal needs for enforceability** - Configure existing events to comply with what your legal team needs to enable you to keep doing business online. |
| 27 | + |
| 28 | + |
| 29 | +## Getting started |
| 30 | + |
| 31 | +1. From the Segment web app, navigate to **Connections > Catalog > Destinations**. |
| 32 | +2. Click the **Destination Actions** category item in the left navigation. |
| 33 | +3. Search for **Ironclad (Actions)** and select it. |
| 34 | +4. Click **Configure Ironclad (Actions)**. |
| 35 | +5. Select an existing Source to connect to Ironclad (Actions). |
| 36 | +6. Set your Site Access Id. |
| 37 | + |
| 38 | + |
| 39 | +### Get your Site Access Id |
| 40 | +In Ironclad, on the Settings page, there's one pane for Account Settings and one for Site Settings. Find the Site Access Id in the Site Settings section. The Site Access ID is unique for each Site within your account and Ironclad uses it to render your Contracts on your website, apps, and other digital surfaces. It is used in your API calls to Ironclad and helps Segment identify your unique Site across the entire cloud-based infrastructure. It is a GUID. |
| 41 | + |
| 42 | + |
| 43 | +To get your Site Access Id: |
| 44 | +1. Log in to Ironclad. |
| 45 | +2. Click the Profile & Settings button at the bottom of the navigation menu on the left (usually contains your photo or your initials). |
| 46 | +3. Click **Settings** from the menu that appears. |
| 47 | +4. Under the site settings pane, you will find **Access Id**. |
| 48 | + |
| 49 | +> success "" |
| 50 | +> If you need the Access ID for a different Site in your account, you need to switch to that Site and find it in the Account Settings there. Use the Change Site button (crossing arrows) near the bottom of the navigation bar on the left side of the screen to sign in to a different Site. |
| 51 | +
|
| 52 | +{% include components/actions-fields.html %} |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +{% comment %} |
| 58 | +## Ironclad mappings and definitions |
| 59 | + |
| 60 | +Once the Ironclad (Actions) Site Access Id is configured, you're ready to finish the rest of the mappings: |
| 61 | + |
| 62 | +1. **Signer ID**: |
| 63 | + 1. Type: `String` |
| 64 | + 2. Description: The unique identifier used to save your signer’s signature. Can be email, mobile number, UUID, or any integer or string. Should be URL encoded |
| 65 | + 3. Mapping: Automatically mapped to `userId` field, if `userId` doesn't exist then its mapped to the `anonymousId` field. |
| 66 | + 4. Required: Yes |
| 67 | +2. **Event Name**: |
| 68 | + 1. Type: `String` |
| 69 | + 2. Description: The name of the event coming from the source, this is an additional information field before the call goes to Ironclad |
| 70 | + 3. Mapping: Automatically mapped to `event` field |
| 71 | + 4. Required: Yes |
| 72 | +3. **Group Id**: |
| 73 | + 1. Type: `String` |
| 74 | + 2. Description: The ID of the Group associated with the acceptance event. You can find your Clickwrap Group ID by clicking into a Clickwrap Group in Ironclad and getting the ID from the URL (for example clickwrap.pactsafe.com/groups/1235) |
| 75 | + 3. Mapping: Manual input |
| 76 | + 4. Required: Yes |
| 77 | +3. **Event Type**: |
| 78 | + 1. Type: `Select` |
| 79 | + 2. Description: The type of event being logged, the available choices are displayed, agreed, and disagreed. |
| 80 | + 3. Mapping: Manual input |
| 81 | + 4. Required: Yes |
| 82 | +4. **Context Parameters**: |
| 83 | + 1. Type: `Object` |
| 84 | + 2. Description: Context Parameters including page, time and other information. |
| 85 | + 3. Mappings: |
| 86 | + `addr`: IP address mapped by default to the `ip` field, |
| 87 | + `ts`: Timestamp field mapped by default to the `timestamp` field, |
| 88 | + `pat`: Page title field mapped by default to the `context.page.title` field, |
| 89 | + `pau`: Page URL field mapped by default to the `context.page.url` field, |
| 90 | + `pap`: Page path field mapped by default to the `context.page.path` field, |
| 91 | + `paq`: Page search field mapped by default to the `context.page.search` field, |
| 92 | + `ref`: Page referrer field mapped by default to the `context.page.referrer` field, |
| 93 | + `btz`: Browser timezone field mapped by default to the `context.timezone` field, |
| 94 | + `bl`: Locale field mapped by default to the `context.locale` field, |
| 95 | + `os`: Operating system name field mapped by default to the `context.os.name`, |
| 96 | + `res`: Screen resolution field mapped by default to the `context.screen` json object, |
| 97 | + 4. Required: No |
| 98 | +4. **Custom Data**: |
| 99 | + 1. Type: `Object` |
| 100 | + 2. Description: Optional. Allows you to append key/value pairs of data to your Clickwrap events. URL encode a JSON object to attach custom data to your Activity. The example is URL encoded for { "first name": "Eric" }. Using this in an “updated” Event Type for Clickwrap will append the data to the Signer, otherwise it will be added to the specific Activity call/transaction. |
| 101 | + 3. Mappings: |
| 102 | + `first_name`: Firstname field mapped by default to the `custom_data.first_name` field, |
| 103 | + `last_name`: Lastname field mapped by default to the `custom_data.last_name` field, |
| 104 | + `company_name`: Company name field mapped by default to the `custom_data.company_name` field, |
| 105 | + `title`: Signer title field mapped by default to the `custom_data.title` field, |
| 106 | + `customer_id`: Customer id field mapped by default to the `custom_data.customer_id` field |
| 107 | + 4. Required: No |
| 108 | +{% endcomment %} |
0 commit comments