Capsule

Capsule is a customer relationship management platform designed to help businesses build stronger customer relationships, increase sales, and save time through intuitive contact management, sales tracking, and task automation features tailored for small and medium-sized businesses.

Power end-to-end data operations for your Capsule API with Nexla. Our bi-directional Capsule connector is purpose-built for Capsule, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Capsule or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Capsule workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Capsule credential, you need to register an OAuth 2.0 application in your Capsule account and obtain the Client ID and Client Secret. Capsule uses OAuth 2.0 with 3-legged authentication (authorization code flow) to securely authenticate API requests.

To set up OAuth 2.0 authentication for Capsule:

1. Create an OAuth Application: Log in to your Capsule account and navigate to the Developer Console or API settings section to create a new OAuth application.

2. Obtain Client Credentials: After creating the OAuth application, you will receive a Client ID and Client Secret. These credentials are used to authenticate with the Capsule API.

3. Configure Redirect URI: Ensure your OAuth application is configured with the appropriate redirect URI for Nexla's OAuth flow.

4. Select Access Scopes: Determine which access scopes your application needs based on the Capsule API endpoints you plan to use. Access scopes determine which resources your application can access.

The OAuth 2.0 authorization URL and token URL are pre-configured by Nexla and do not require manual entry. Nexla automatically handles the OAuth 2.0 authorization code flow, including the authorization redirect, token exchange, and token refresh.

For detailed information about Capsule OAuth 2.0 setup, application registration, and available scopes, refer to the Capsule API authentication documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Client ID	Yes	Yes	Capsule Client ID
Access Scope	No	No	Capsule Access Scope
Client Secret	No	Yes	Capsule Client Secret for Token URL

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Capsule

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Capsule OAuth Client ID in the Client ID field. This is the Client ID you obtained from your Capsule OAuth application registration. The Client ID is used together with the Client Secret to authenticate and obtain OAuth 2.0 access tokens.

4. Enter your Capsule OAuth Client Secret in the Client Secret field. This is the Client Secret you obtained from your Capsule OAuth application registration. The Client Secret is used together with the Client ID to securely authenticate and obtain OAuth 2.0 access tokens.

5. Enter the access scope for your Capsule application in the Access Scope field. This determines which Capsule API resources your application can access. Leave this field empty if you want to use the default scope, or specify the required scopes based on the Capsule API endpoints you plan to use.

   The Client ID and Client Secret are used for OAuth 2.0 authorization code flow authentication. The credentials are exchanged for an access token using the Capsule token endpoint (https://api.capsulecrm.com/oauth/token). The access token is then used in the Authorization: Bearer {token} header for all API requests. Keep your Client Secret secure and do not share it publicly or commit it to version control systems. The OAuth 2.0 authorization URL (https://api.capsulecrm.com/oauth/authorise) and token URL are pre-configured and handled automatically by Nexla. For detailed information about Capsule OAuth 2.0 authentication, available scopes, and API access, see the Capsule API authentication documentation.

6. When you create a Capsule credential, Nexla will prompt you to authenticate with your Capsule account. Follow the OAuth 2.0 authorization prompts to grant Nexla access to your Capsule account resources.

7. Click the Save button at the bottom of the overlay to save the configured credential. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Capsule connector tile, then select the credential that will be used to connect to the Capsule instance, and click Next; or, create a new Capsule credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Capsule endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get Parties

This endpoint retrieves the collection of parties (contacts, organizations, and people) from your Capsule account. Use this endpoint when you need to access contact information, organization details, or party data for CRM management, reporting, or analysis.

• This endpoint automatically retrieves all parties from your Capsule account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://api.capsulecrm.com/api/v2/parties. The endpoint URL is automatically constructed based on the Capsule API base URL.
• The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and perPage query parameters. The endpoint starts from page 1 and continues fetching pages until all available parties have been retrieved. By default, the endpoint retrieves up to 100 items per page.
• The endpoint will return all parties in your account. The response data is extracted from the parties array in the API response ($.parties[*]), with each party record processed individually.

This endpoint supports pagination through page and perPage query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.parties[*], which extracts all items from the parties array in the API response. For detailed information about retrieving parties, see the Capsule API documentation.

Get Tasks

This endpoint retrieves the collection of tasks from your Capsule account. Use this endpoint when you need to access task information for project management, follow-up tracking, or task analysis.

• This endpoint automatically retrieves all tasks from your Capsule account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://api.capsulecrm.com/api/v2/tasks. The endpoint URL is automatically constructed based on the Capsule API base URL.
• The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and perPage query parameters. The endpoint starts from page 1 and continues fetching pages until all available tasks have been retrieved. By default, the endpoint retrieves up to 100 items per page.
• The endpoint will return all tasks in your account. The response data is extracted from the tasks array in the API response ($.tasks[*]), with each task record processed individually.

This endpoint supports pagination through page and perPage query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 100 items per page (page.expected.rows: 100). The response data path is $.tasks[*], which extracts all items from the tasks array in the API response. For detailed information about retrieving tasks, see the Capsule API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Capsule data sources can also be manually configured to ingest data from any valid Capsule API v2 endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, path to data, and request headers. Capsule API endpoints follow the pattern https://api.capsulecrm.com/api/v2/{endpoint_path}, and response data is typically extracted using JSON paths such as $.parties[*] or $.tasks[*].

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Capsule data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Capsule destination, and select the Send to Destination option from the menu. Select the Capsule connector from the list of available destination connectors, then select the credential that will be used to connect to the Capsule organization, and click Next; or, create a new Capsule credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Capsule endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Party

This endpoint creates a new party (contact, organization, or person) in your Capsule account. Use this endpoint when you need to create contacts or organizations from your data sources, such as importing contact information or creating new CRM records.

• The endpoint uses POST requests to https://api.capsulecrm.com/api/v2/parties. The endpoint URL is automatically constructed based on the Capsule API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the party data to create. The request body should follow the Capsule API v2 specification for creating parties, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a party. If you need to create multiple parties, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Capsule API v2 specification for creating parties. The endpoint requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating parties, including required fields, field names, and request formats, see the Capsule API documentation.

Create Task

This endpoint creates a new task in your Capsule account. Use this endpoint when you need to create tasks from your data sources, such as setting up follow-up tasks or creating task records for project management.

• The endpoint uses POST requests to https://api.capsulecrm.com/api/v2/tasks. The endpoint URL is automatically constructed based on the Capsule API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the task data to create. The request body should follow the Capsule API v2 specification for creating tasks, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a task. If you need to create multiple tasks, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Capsule API v2 specification for creating tasks. The endpoint requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating tasks, including required fields, field names, and request formats, see the Capsule API documentation.

Manual configuration

Capsule destinations can also be manually configured to send data to any valid Capsule API v2 endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, and request headers. The Capsule API v2 primarily uses POST requests with JSON request bodies, and endpoints follow the pattern https://api.capsulecrm.com/api/v2/{endpoint_path}. Using manual configuration, you can also configure Nexla to automatically send the response received from the Capsule API after each call to a new Nexla webhook data source.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Capsule endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Capsule endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.