Integrations
Build custom integrations in Oktopost.
These endpoints enable partners to build and manage integrations in Oktopost. You can list existing integrations, retrieve integration details, and manage integration connections.
Partner Access Only
The ability to create and manage custom integrations is available exclusively to authorized partners. If you're interested in building an integration with Oktopost, please contact our partnerships team.
List Integrations
Retrieve a list of all connected integrations for an account. You can filter by integration type and use pagination to navigate results.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | String | No | Filter by integration type. Options: cd, ga, pardot, netresults, mautic, facebook |
| _page | Integer | No | Page number for pagination. Default: 0 |
| _count | Integer | No | Number of items per page. Options: 25, 50, 100. Default: 25 |
Request
curl -u ACCOUNT_ID:API_KEY \
"https://api.oktopost.com/v2/integration?type=facebook"Response
{
"Result": true,
"Items": [
{
"Id": "014000000000001",
"Created": "2016-12-18 12:47:58",
"Modified": "2017-05-21 11:02:55",
"Status": "valid",
"State": "active",
"AccountId": "001000000000001",
"Type": "facebook",
"Version": 1,
"CnameId": null,
"SettingsData": { ... }
}
],
"Total": 1
}Response Fields
| Field | Description |
|---|---|
| Status | Integration connection status. Values: valid, invalid |
| State | Integration operational state. Values: active, disabled |
| Type | The platform this integration connects to. |
| CnameId | Custom domain identifier associated with this integration. |
Get Integration
Retrieve detailed information about a specific integration, including optionally its associated assets like social credentials and boards.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| withAssets | Integer | No | Set to 1 to include associated assets (credentials, boards) in the response. |
Request
curl -u ACCOUNT_ID:API_KEY \
"https://api.oktopost.com/v2/integration/014000000000001?withAssets=1"Response
{
"Result": true,
"Integration": {
"Id": "014000000000001",
"Created": "2016-12-18 12:47:58",
"Modified": "2017-05-21 11:02:55",
"Status": "valid",
"State": "active",
"AccountId": "001000000000001",
"Type": "facebook",
"Version": 1,
"CnameId": null,
"SettingsData": { ... },
"Assets": {
"Credentials": [
{
"Id": "003-001000000000001-123456",
"Name": "John Smith's LinkedIn",
"DisplayName": "John Smith",
"Status": "valid",
"Network": "LinkedIn"
}
],
"Boards": [...]
}
}
}Connect Integration
Create a new integration connection between Oktopost and an external platform.
Additional parameters may be required depending on the integration type. Contact our team for integration-specific requirements.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | String | Yes | The integration type to connect. See supported types above. |
| cnameId | String | Yes | The custom domain (CNAME) identifier for this integration. |
Request
curl -u ACCOUNT_ID:API_KEY \
https://api.oktopost.com/v2/integration -X POST \
-d cnameId="0CN000000000000" \
-d type="cd"Response
{
"Result": true,
"Integration": {
"Id": "014000000000001",
"Type": "cd",
"Status": "valid",
"State": "active"
}
}Update Integration
Modify an existing integration's configuration, such as enabling/disabling it or updating its CNAME.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| state | String | No | Change the integration state. Accepted values: active, disabled |
| cnameId | String | No | Update the custom domain identifier for this integration. |
Additional parameters may be supported depending on the integration type. Contact our team for integration-specific update options.
Request
curl -u ACCOUNT_ID:API_KEY \
https://api.oktopost.com/v2/integration/014000000000001 -X POST \
-d state="disabled"Response
{
"Result": true
}Delete Integration
Remove an integration connection. This action cannot be undone.
Request
curl -u ACCOUNT_ID:API_KEY \
https://api.oktopost.com/v2/integration/014000000000001 -X DELETEResponse
{
"Result": true
}Integration States
Understanding the difference between Status and State:
- Status indicates the technical validity of the connection (e.g., are credentials still valid?)
- State indicates whether the integration is actively processing data
An integration can be valid but disabled, meaning the connection works but data syncing is paused.