External integrations API guide

External integrations API guide #

The external integrations API guide helps you connect external systems such as websites, applications, and services to your account using API requests.

This allows you to send data, trigger actions, and automate workflows from outside the platform.

When to use external integrations API guide #

Use the external integrations API guide when you need to:

• Send contacts from your website or app
• Trigger automation workflows from external events
• Sync data between systems
• Build custom integrations

Before you start with external integrations API guide #

Make sure:

• You have generated valid API tokens
• Your account has API access enabled
• You understand your integration requirements

👉 Generate tokens here:
API tokens

How external integrations API guide works #

External integrations use API requests to communicate with the platform.

Typical flow:

1. External system sends a request
2. API authenticates using API tokens
3. Data is processed (contact, event, or trigger)
4. System performs the requested action

Common use cases in external integrations API guide #

Send contacts from a website #

• Capture form data
• Send it to the platform
• Automatically store it in Contacts

👉 See:
Import contacts in Peikly (CSV & Excel Guide)

Trigger workflows from external systems #

• User submits a form
• External system sends event
• Workflow starts automatically

👉 See:
Automation workflows: build & manage

Sync data between systems #

• Keep CRM data updated
• Sync customer activity
• Track events across platforms

Authentication in external integrations API guide #

All requests require API tokens.

• Include API token in request headers
• Ensure secure transmission (HTTPS)
• Validate token before sending data

Common issues in external integrations API guide #

API request not working #

Possible causes:

• Invalid API tokens
• Incorrect endpoint
• Missing request fields

How to fix:

1. Verify API token
2. Check request format
3. Confirm endpoint configuration

Data not appearing in system #

Possible causes:

• Incorrect mapping
• Validation failure
• Missing required fields

How to fix:

• Validate request payload
• Check required fields
• Review system logs

Workflow not triggered #

Possible causes:

• Wrong trigger event
• Workflow inactive
• Event not mapped correctly

How to fix:

• Activate workflow
• Verify trigger configuration
• Test with sample request

Best practices for external integrations API guide #

• Use separate API tokens for each system
• Log API requests for debugging
• Test integrations in a controlled environment
• Validate data before sending

Related guides #

• 👉 API tokens
• 👉 Automation workflows: build & manage
• 👉 Manage users in Peikly