Parallel

Parallel profiles work similarly to CRM objects, allowing you to programmatically manage and track your customer information. This guide will help you understand how to integrate your systems with Parallel profiles using our API and webhooks.

Before starting the integration, make sure you have:

An <a href="https://intercom.help/onparallel/en/articles/6076347-manage-tokens-to-access-the-api" rel="nofollow noopener noreferrer" target="_blank">API key</a> with the necessary permissions to manage profiles.

A clear understanding of your <a href="https://intercom.help/onparallel/en/articles/8173714-creating-different-types-of-profiles" rel="nofollow noopener noreferrer" target="_blank">profile types and properties</a>.

Properly configured <a href="https://intercom.help/onparallel/en/articles/8395447-user-permissions-in-your-organization" rel="nofollow noopener noreferrer" target="_blank">access permissions</a> for the integration user.

1. An <a href="https://intercom.help/onparallel/en/articles/6076347-manage-tokens-to-access-the-api" rel="nofollow noopener noreferrer" target="_blank">API key</a> with the necessary permissions to manage profiles.
2. A clear understanding of your <a href="https://intercom.help/onparallel/en/articles/8173714-creating-different-types-of-profiles" rel="nofollow noopener noreferrer" target="_blank">profile types and properties</a>.
3. Properly configured <a href="https://intercom.help/onparallel/en/articles/8395447-user-permissions-in-your-organization" rel="nofollow noopener noreferrer" target="_blank">access permissions</a> for the integration user.

There are two main ways to interact with Parallel Profiles:

<a href="https://www.onparallel.com/developers/api#tag/Profiles" rel="nofollow noopener noreferrer" target="_blank">REST API</a>: For direct operations such as creating, reading, updating, and listing profiles

<a href="https://www.onparallel.com/developers/api#tag/Webhooks/Profile-Events" rel="nofollow noopener noreferrer" target="_blank">Webhooks</a>: For receiving real-time notifications about profile changes

1. <a href="https://www.onparallel.com/developers/api#tag/Profiles" rel="nofollow noopener noreferrer" target="_blank">REST API</a>: For direct operations such as creating, reading, updating, and listing profiles
2. <a href="https://www.onparallel.com/developers/api#tag/Webhooks/Profile-Events" rel="nofollow noopener noreferrer" target="_blank">Webhooks</a>: For receiving real-time notifications about profile changes

Parallel sends webhook notifications for various profile events. Here are the main events you might want to handle:

<code>PROFILE_CREATED</code>: Triggered when a new profile is created.

<code>PROFILE_UPDATED</code>: Sent after any profile property is updated.

- <code>PROFILE_CREATED</code>: Triggered when a new profile is created.
- <code>PROFILE_UPDATED</code>: Sent after any profile property is updated.

<code>PROFILE_RELATIONSHIP_CREATED</code>: When profiles are linked.

<code>PROFILE_RELATIONSHIP_REMOVED</code>: When relationships between profiles are removed.

- <code>PROFILE_RELATIONSHIP_CREATED</code>: When profiles are linked.
- <code>PROFILE_RELATIONSHIP_REMOVED</code>: When relationships between profiles are removed.

<code>PROFILE_CLOSED</code>: When a profile is closed.

<code>PROFILE_REOPENED</code>: When a closed profile is reactivated.

<code>PROFILE_SCHEDULED_FOR_DELETION</code>: Before permanent deletion.

<code>PROFILE_ANONYMIZED</code>: When a profile has been anonymized after the data retention period.

- <code>PROFILE_CLOSED</code>: When a profile is closed.
- <code>PROFILE_REOPENED</code>: When a closed profile is reactivated.
- <code>PROFILE_SCHEDULED_FOR_DELETION</code>: Before permanent deletion.
- <code>PROFILE_ANONYMIZED</code>: When a profile has been anonymized after the data retention period.

Error handling: Implement proper error handling for both API calls and webhook processing.

- Implement idempotency checks using the event ID.
- Add retry logic for failed processing.
- Store raw webhooks before processing them.
   

- Use webhooks for real-time updates.
- Implement periodic full synchronization to ensure consistency.
- Handle data conflicts appropriately.
   

- Keep your API keys secure.
- Validate webhook signatures.
- Follow the principle of least privilege when configuring integration users.

1. Error handling: Implement proper error handling for both API calls and webhook processing.
 
2. Webhook reliability:
 - Implement idempotency checks using the event ID.
 - Add retry logic for failed processing.
 - Store raw webhooks before processing them.
 
3. Data synchronization:
 - Use webhooks for real-time updates.
 - Implement periodic full synchronization to ensure consistency.
 - Handle data conflicts appropriately.
 
4. Security:
 - Keep your API keys secure.
 - Validate webhook signatures.
 - Follow the principle of least privilege when configuring integration users.

Remember that different profile types (for example, individuals vs. companies) have different properties and requirements:

Individual Profiles: Focused on personal identification and verification.

Company Profiles: Handle corporate structure and ownership information.

- Individual Profiles: Focused on personal identification and verification.
- Company Profiles: Handle corporate structure and ownership information.

Check the API documentation at <a href="https://www.onparallel.com/developers/api" rel="nofollow noopener noreferrer" target="_blank">https://www.onparallel.com/developers/api</a>.

Contact Parallel support for technical assistance.

1. Check the API documentation at <a href="https://www.onparallel.com/developers/api" rel="nofollow noopener noreferrer" target="_blank">https://www.onparallel.com/developers/api</a>.
2. Contact Parallel support for technical assistance.

Prerequisites

Profile integration points

Implementing Webhook listeners

Profile creation and updates

Relationship changes

Status changes

Best practices

Managing different profile types

Getting help