Last updated 8 months ago
Was this helpful?
Management API
Get Entity Options
GET /dev/api/entities/options/{credentialId} HTTP/1.1 Host: localhost:3001 Accept: */*
No content
Create Entity
POST /dev/api/entities HTTP/1.1 Host: localhost:3001 Accept: */*
List Integrations
{{appOrgId}}
{{appUserId}}
GET /dev/api/integrations HTTP/1.1 Host: localhost:3001 Accept: */*
List Integration Options
GET /dev/api/integrations/options HTTP/1.1 Host: localhost:3001 Accept: */*
Get Integration
GET /dev/api/integrations/{integrationId} HTTP/1.1 Host: localhost:3001 Accept: */*
Get Integration Config Options
GET /dev/api/integrations/{integrationId}/config/options HTTP/1.1 Host: localhost:3001 Accept: */*
Get User Action Options
GET /dev/api/integrations/{integrationId}/actions/{actionId}/options HTTP/1.1 Host: localhost:3001 Accept: */*
Submit User Action
POST /dev/api/integrations/65bbfe8e4124ba1e42b939e4/actions/DELETE_ALL_CUSTOM_OBJECTS HTTP/1.1 Host: localhost:3001 Authorization: Bearer YOUR_SECRET_TOKEN Accept: */*
Get Auth Requirements
sharepoint
demo
GET /dev/api/authorize HTTP/1.1 Host: localhost:3001 Accept: */*
Auth (Callback)
{{entityType}}
POST /dev/api/authorize HTTP/1.1 Host: localhost:3001 Content-Type: application/json Accept: */* Content-Length: 232 "{\n \"entityType\":\"{{targetEntityType}}\",\n \"data\": {\n \"subdomain\": {{userProvidedSubdomain}},\n \"public_key\": {{userProvidedPublicKey}},\n \"private_key\": {{userProvidedPrivateKey}}\n }\n}"
OAuth Example
{ "type": "{{entityType}}", "credential_id": {{generatedCredentialId}}, "entity_id": {{generatedEntityId}} }
Create Integration
["{{yourAppEntityId}}","{{targetAppEntityId}}"]
POST /dev/api/integrations HTTP/1.1 Host: localhost:3001 Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 60 { "entities": [ "{{yourAppEntityId}}", "{{targetAppEntityId}}" ] }
{ "id":"{{generatedIntegrationId}}", "entities":[ "{{yourAppEntityId}}", "{{targetAppEntityId}}" ], "status": "ENABLED", // Enums: ENABLED, DISABLED, NEEDS_CONFIG, PROCESSING, ERROR "config": { "type": "{{targetIntegrationType}}", "enable": { "sync": true, "webhooks": "true" }, "map": { "syncMap": { "freshbooksEntityId": [ "name.first", "name.last" ], "salesforceEntityId": [ "firstName", "lastName" ] } } } }
Delete Integration
integration1
DELETE /dev/api/integrations/{integrationId} HTTP/1.1 Host: localhost:3001 Content-Type: application/json Accept: */* Content-Length: 21 { "id": "integration1" }
{}
Update Integration
user123
org123
PATCH /dev/api/integrations/{integrationId} HTTP/1.1 Host: localhost:3001 Content-Type: application/json Accept: */* Content-Length: 186 { "config": { "enable": { "sync": true, "webhooks": false }, "map": { "syncMap": { "freshbooksEntityId": [ "name.first", "name.last" ], "salesforceEntityId": [ "firstName", "lastName" ] } } }, "id": "integration1" }
