Plan an integration
plan_integrationIntegrations (between two systems): Use when someone wants to set up a sync between two systems, for example "when a deal is won in our CRM, make a draft invoice in our accounting system" or "keep our customers and invoices the same in both systems". It checks the plan against what CRM Connector offers and returns the record types that will travel, in which direction, plus a link that opens the setup wizard prefilled, where the person signs in, connects both systems and reviews everything before anything syncs. It plans one way unless direction is both_ways; then every chosen record type the pair can carry back travels both ways, and the answer names what stays one way and why. Call find_sync_options first when you do not know which record types a pair offers or which travel both ways. Not for questions about what is possible (use find_sync_options) or for a person's own integrations; nothing is created by this tool: the person finishes the setup in CRM Connector.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| trigger | No | Optional moment a record must reach before it travels, for example paid or overdue (invoices) or accepted (quotes). It applies to every chosen record type that can wait for it; the others travel when created. | |
| direction | No | Optional: one_way (the default) copies records from the source into the target; both_ways also sends changes made in the target back, for every chosen record type the pair carries both ways (find_sync_options marks them). Choose both_ways only when the person wants changes to flow back. Record types that cannot travel both ways stay one way, and the answer says which. | one_way |
| record_types | Yes | What should travel, at least one, by the keys find_sync_options returns: "invoice" copies invoices, "deal_to_invoice" turns won deals into draft invoices. Contacts are always added when the pair carries them. | |
| source_system | Yes | The system records come from, by its key. | |
| target_system | Yes | The system records go into, by its key. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | Yes | ||
| sheet | Yes | ||
| source | Yes | ||
| target | Yes | ||
| outcome | Yes | ||
| summary | Yes | ||
| direction | Yes | ||
| wizardUrl | Yes | ||
| notIncluded | Yes | ||
| recordTypes | Yes | ||
| requestIntegrationUrl | Yes |