Left HookDemo

API Reference

Management API

Get Auth Requirements

get

Get Auth Requirements

Query parameters
entityTypestringOptionalExample: sharepoint
connectingEntityTypestringOptionalExample: demo
Responses
200Success
get
GET /dev/api/authorize HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Auth (Callback)

post

Auth (Callback)

Body
entityTypestringOptionalExample: {{entityType}}
Responses
201
OAuth Example
text/plain
post
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}"
201

OAuth Example

{

    "type": "{{entityType}}",
    "credential_id": {{generatedCredentialId}},
    "entity_id": {{generatedEntityId}}
}

Get Entity Options

get

Get Entity Options

Path parameters
credentialIdstringRequired
Responses
200Success
get
GET /dev/api/entities/options/{credentialId} HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Create Entity

post

Create Entity

Responses
200Success
post
POST /dev/api/entities HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

List Integrations

get

List Integrations

Header parameters
x-frigg-apporgidstringOptionalExample: {{appOrgId}}
x-frigg-appuseridstringOptionalExample: {{appUserId}}
Responses
200Success
get
GET /dev/api/integrations HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Create Integration

post

Create Integration

Authorizations
Body
entitiesstring[]OptionalExample: ["{{yourAppEntityId}}","{{targetAppEntityId}}"]
Responses
201
Create Integration
text/plain
post
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}}"
  ]
}
201

Create Integration

{
    "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"
                ]
            }
        }
    }
}

List Integration Options

get

List Integration Options

Responses
200Success
get
GET /dev/api/integrations/options HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Get Integration

get

Get Integration

Path parameters
integrationIdstringRequired
Responses
200Success
get
GET /dev/api/integrations/{integrationId} HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Delete Integration

delete

Delete Integration

Path parameters
integrationIdstringRequired
Body
idstringOptionalExample: integration1
Responses
202
Delete Integration
application/json
Responseobject
delete
DELETE /dev/api/integrations/{integrationId} HTTP/1.1
Host: localhost:3001
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "id": "integration1"
}
202

Delete Integration

{}

Update Integration

patch

Update Integration

Path parameters
integrationIdstringRequired
Header parameters
x-frigg-appuseridstringOptionalExample: user123
x-frigg-apporgidstringOptionalExample: org123
Body
idstringOptionalExample: integration1
Responses
200Success
patch
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"
}
200Success
No content

Get Integration Config Options

get

Get Integration Config Options

Path parameters
integrationIdstringRequired
Responses
200Success
get
GET /dev/api/integrations/{integrationId}/config/options HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Get User Action Options

get

Get User Action Options

Path parameters
integrationIdstringRequired
actionIdstringRequired
Responses
200Success
get
GET /dev/api/integrations/{integrationId}/actions/{actionId}/options HTTP/1.1
Host: localhost:3001
Accept: */*
200Success
No content

Submit User Action

post

Submit User Action

Authorizations
Responses
200Success
post
POST /dev/api/integrations/65bbfe8e4124ba1e42b939e4/actions/DELETE_ALL_CUSTOM_OBJECTS HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content

Last updated

Was this helpful?