Last updated 7 months ago
Was this helpful?
Management API
Get Entity Options
curl -L \ --url 'http://localhost:3001/dev/api/entities/options/{credentialId}'
No body
Create Entity
curl -L \ --request POST \ --url 'http://localhost:3001/dev/api/entities'
List Integrations
{{appOrgId}}
{{appUserId}}
curl -L \ --url 'http://localhost:3001/dev/api/integrations'
List Integration Options
curl -L \ --url 'http://localhost:3001/dev/api/integrations/options'
Get Integration
curl -L \ --url 'http://localhost:3001/dev/api/integrations/{integrationId}'
Get Integration Config Options
curl -L \ --url 'http://localhost:3001/dev/api/integrations/{integrationId}/config/options'
Get User Action Options
curl -L \ --url 'http://localhost:3001/dev/api/integrations/{integrationId}/actions/{actionId}/options'
Submit User Action
curl -L \ --request POST \ --url 'http://localhost:3001/dev/api/integrations/65bbfe8e4124ba1e42b939e4/actions/DELETE_ALL_CUSTOM_OBJECTS' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
Get Auth Requirements
sharepoint
demo
curl -L \ --url 'http://localhost:3001/dev/api/authorize'
Auth (Callback)
{{entityType}}
curl -L \ --request POST \ --url 'http://localhost:3001/dev/api/authorize' \ --header 'Content-Type: application/json' \ --data '"{ \"entityType\":\"{{targetEntityType}}\", \"data\": { \"subdomain\": {{userProvidedSubdomain}}, \"public_key\": {{userProvidedPublicKey}}, \"private_key\": {{userProvidedPrivateKey}} } }"'
{ "type": "{{entityType}}", "credential_id": {{generatedCredentialId}}, "entity_id": {{generatedEntityId}} }
Create Integration
["{{yourAppEntityId}}","{{targetAppEntityId}}"]
curl -L \ --request POST \ --url 'http://localhost:3001/dev/api/integrations' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "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
curl -L \ --request DELETE \ --url 'http://localhost:3001/dev/api/integrations/{integrationId}' \ --header 'Content-Type: application/json' \ --data '{ "id": "integration1" }'
{}
Update Integration
user123
org123
curl -L \ --request PATCH \ --url 'http://localhost:3001/dev/api/integrations/{integrationId}' \ --header 'Content-Type: application/json' \ --data '{ "config": { "enable": { "sync": true, "webhooks": false }, "map": { "syncMap": { "freshbooksEntityId": [ "name.first", "name.last" ], "salesforceEntityId": [ "firstName", "lastName" ] } } }, "id": "integration1" }'
