API Reference

Management API

Authorization

Get Auth Requirements

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/authorize

Returns the authorization requirements for the given entity type (for OAuth this is typically a redirect url; for API-key/basic auth it is a jsonSchema/uiSchema form definition).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Query parameters

entityTypestringRequired

The API Module / entity type to authorize.

Example: hubspot

statestringOptional

Optional OAuth state value forwarded into the authorization-requirements lookup.

Example: abc123

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Authorization requirements.

application/json

For OAuth flows, typically { type, url }. For credential/form flows, typically { type, data: { jsonSchema, uiSchema } }.

typestringOptionalExample: oauth2

urlstringOptionalExample: https://app.example.com/oauth/authorize?client_id=...

Other propertiesanyOptional

get/api/authorize

HTTPcURLJavaScriptPython

GET /dev/api/authorize?entityType=hubspot HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Authorization requirements.

{
  "type": "oauth2",
  "url": "https://app.example.com/oauth/authorize?client_id=...",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Auth (Callback)

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/authorize

Processes an authorization callback (e.g. an OAuth code exchange or submitted credential form) and creates/links the credential and entity for the acting user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

entityTypestringRequiredExample: hubspot

Responses

200

Credential and entity created/linked.

application/json

typestringOptionalExample: hubspot

credential_idstringOptionalExample: {{generatedCredentialId}}

entity_idstringOptionalExample: {{generatedEntityId}}

Other propertiesanyOptional

post/api/authorize

HTTPcURLJavaScriptPython

POST /dev/api/authorize HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "entityType": "hubspot",
  "data": {
    "code": "{{oauthCode}}"
  }
}

OAuth callbackAPI key callback

200

Credential and entity created/linked.

{
  "type": "hubspot",
  "credential_id": "{{generatedCredentialId}}",
  "entity_id": "{{generatedEntityId}}",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Integrations

List Integrations

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations

Returns integration options, the entities the user is authorized to use, and the user's existing integrations (each annotated with its available userActions).

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Integration options, authorized entities, and integrations.

application/json

get/api/integrations

HTTPcURLJavaScriptPython

GET /dev/api/integrations HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Integration options, authorized entities, and integrations.

{
  "entities": {
    "options": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "authorized": [
      {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "integrations": [
    {
      "id": "{{integrationId}}",
      "entities": [
        "text"
      ],
      "status": "ENABLED",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "userActions": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ]
}

Create Integration

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations

Creates an integration from a pair of entities and a config object, then runs the integration's onCreate lifecycle hook.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

entitiesstring[]RequiredExample: ["{{yourAppEntityId}}","{{targetAppEntityId}}"]

Responses

201

The created, formatted integration.

application/json

idstringOptionalExample: {{integrationId}}

entitiesstring[]Optional

statusstring · enumOptionalPossible values:

post/api/integrations

HTTPcURLJavaScriptPython

POST /dev/api/integrations HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "entities": [
    "{{yourAppEntityId}}",
    "{{targetAppEntityId}}"
  ],
  "config": {
    "type": "{{targetIntegrationType}}"
  }
}

201

The created, formatted integration.

{
  "id": "{{generatedIntegrationId}}",
  "entities": [
    "{{yourAppEntityId}}",
    "{{targetAppEntityId}}"
  ],
  "status": "ENABLED",
  "config": {
    "type": "{{targetIntegrationType}}",
    "enable": {
      "sync": true,
      "webhooks": true
    },
    "map": {
      "syncMap": {
        "freshbooksEntityId": [
          "name.first",
          "name.last"
        ],
        "salesforceEntityId": [
          "firstName",
          "lastName"
        ]
      }
    }
  }
}

Get Integration

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}

Returns the integration's id, entities, status, and config.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

The integration.

application/json

idstringOptionalExample: {{integrationId}}

entitiesstring[]Optional

statusstring · enumOptionalPossible values:

get/api/integrations/{integrationId}

HTTPcURLJavaScriptPython

GET /dev/api/integrations/{integrationId} HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The integration.

{
  "id": "{{integrationId}}",
  "entities": [
    "text"
  ],
  "status": "ENABLED",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "userActions": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Update Integration

patch

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}

Updates an integration's config and runs the integration's onUpdate lifecycle hook.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

Responses

200

The updated, formatted integration.

application/json

idstringOptionalExample: {{integrationId}}

entitiesstring[]Optional

statusstring · enumOptionalPossible values:

patch/api/integrations/{integrationId}

HTTPcURLJavaScriptPython

PATCH /dev/api/integrations/{integrationId} HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "config": {
    "enable": {
      "sync": true,
      "webhooks": false
    },
    "map": {
      "syncMap": {
        "freshbooksEntityId": [
          "name.first",
          "name.last"
        ],
        "salesforceEntityId": [
          "firstName",
          "lastName"
        ]
      }
    }
  }
}

200

The updated, formatted integration.

{
  "id": "{{integrationId}}",
  "entities": [
    "text"
  ],
  "status": "ENABLED",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "userActions": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Delete Integration

delete

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}

Runs the integration's onDelete lifecycle hook and removes the integration for the acting user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

204

Integration deleted. No content.

No content

delete/api/integrations/{integrationId}

HTTPcURLJavaScriptPython

DELETE /dev/api/integrations/{integrationId} HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Integration deleted. No content.

No content

Get Integration Config Options

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/config/options

Returns the dynamic config-options form for the integration.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Config options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

get/api/integrations/{integrationId}/config/options

HTTPcURLJavaScriptPython

GET /dev/api/integrations/{integrationId}/config/options HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Config options.

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Refresh Integration Config Options

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/config/options/refresh

Re-evaluates the config-options form given the current (partial) config submission, e.g. to populate dependent dropdowns.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

Other propertiesanyOptional

Responses

200

Refreshed config options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

post/api/integrations/{integrationId}/config/options/refresh

HTTPcURLJavaScriptPython

POST /dev/api/integrations/{integrationId}/config/options/refresh HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

200

Refreshed config options.

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List User Actions

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/actions

Lists the user actions available for the integration. The route is registered with .all, so it responds to any HTTP method; GET is the typical call.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Available user actions.

application/json

Other propertiesanyOptional

get/api/integrations/{integrationId}/actions

HTTPcURLJavaScriptPython

GET /dev/api/integrations/{integrationId}/actions HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Available user actions.

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get User Action Options

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/actions/{actionId}/options

Returns the dynamic options form for a given user action.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

actionIdstringRequired

The user action identifier.

Example: DELETE_ALL_CUSTOM_OBJECTS

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Action options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

get/api/integrations/{integrationId}/actions/{actionId}/options

HTTPcURLJavaScriptPython

GET /dev/api/integrations/{integrationId}/actions/{actionId}/options HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Action options.

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Refresh User Action Options

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/actions/{actionId}/options/refresh

Re-evaluates a user action's options form given the current (partial) submission.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

actionIdstringRequired

The user action identifier.

Example: DELETE_ALL_CUSTOM_OBJECTS

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

Other propertiesanyOptional

Responses

200

Refreshed action options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

post/api/integrations/{integrationId}/actions/{actionId}/options/refresh

HTTPcURLJavaScriptPython

POST /dev/api/integrations/{integrationId}/actions/{actionId}/options/refresh HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

200

Refreshed action options.

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Submit User Action

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/actions/{actionId}

Submits/triggers a user action on the integration (calls the integration's notify(actionId, body)). The request body is the action-specific payload.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

actionIdstringRequired

The user action identifier.

Example: DELETE_ALL_CUSTOM_OBJECTS

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

Other propertiesanyOptional

Responses

200

Action result.

application/json

Other propertiesanyOptional

post/api/integrations/{integrationId}/actions/{actionId}

HTTPcURLJavaScriptPython

POST /dev/api/integrations/{integrationId}/actions/{actionId} HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "confirm": true
}

200

Action result.

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Test Integration Auth

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/integrations/{integrationId}/test-auth

Runs testAuth against the integration's entities and reports any authentication errors raised during the check.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

integrationIdstringRequired

The integration's id.

Example: {{integrationId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Authentication is healthy.

application/json

statusstringOptionalExample: ok

400

Authentication errors were detected.

application/json

get/api/integrations/{integrationId}/test-auth

HTTPcURLJavaScriptPython

GET /dev/api/integrations/{integrationId}/test-auth HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ok"
}

Entities

Create Entity

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/entity

Finds or creates an entity for a previously-created credential. data.credential_id is required and must reference an existing credential.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

entityTypestringRequiredExample: hubspot

Responses

200

The found or created entity.

application/json

idstringOptional

userstringOptional

namestringOptional

Other propertiesanyOptional

post/api/entity

HTTPcURLJavaScriptPython

POST /dev/api/entity HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "entityType": "hubspot",
  "data": {
    "credential_id": "{{generatedCredentialId}}"
  }
}

200

The found or created entity.

{
  "id": "text",
  "user": "text",
  "name": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Entity Options (by Credential)

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/entity/options/{credentialId}

Returns the entity-selection options available for a credential (e.g. selectable accounts/workspaces). The credential must belong to the acting user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

credentialIdstringRequired

The credential's id.

Example: {{credentialId}}

Query parameters

entityTypestringRequired

The API Module / entity type the credential belongs to.

Example: hubspot

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Entity options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

403

The credential does not belong to the acting user.

application/json

get/api/entity/options/{credentialId}

HTTPcURLJavaScriptPython

GET /dev/api/entity/options/{credentialId}?entityType=hubspot HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get Entity

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/entities/{entityId}

Returns the entity record for the given entity id.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

entityIdstringRequired

The entity's id.

Example: {{entityId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

The entity.

application/json

idstringOptional

userstringOptional

namestringOptional

Other propertiesanyOptional

404

Entity not found for the acting user.

get/api/entities/{entityId}

HTTPcURLJavaScriptPython

GET /dev/api/entities/{entityId} HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "user": "text",
  "name": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Test Entity Auth

get

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/entities/{entityId}/test-auth

Runs testAuth against a single entity's credential.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

entityIdstringRequired

The entity's id.

Example: {{entityId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Responses

200

Authentication is healthy.

application/json

statusstringOptionalExample: ok

400

Authentication error for this entity.

application/json

404

Entity not found for the acting user.

get/api/entities/{entityId}/test-auth

HTTPcURLJavaScriptPython

GET /dev/api/entities/{entityId}/test-auth HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ok"
}

Get Entity Options (by Entity)

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/entities/{entityId}/options

Returns the options form for an existing entity.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

entityIdstringRequired

The entity's id.

Example: {{entityId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

Other propertiesanyOptional

Responses

200

Entity options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

404

Entity not found for the acting user.

post/api/entities/{entityId}/options

HTTPcURLJavaScriptPython

POST /dev/api/entities/{entityId}/options HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Refresh Entity Options

post

http://localhost:3001/devhttps://your-api-id.execute-api.us-east-1.amazonaws.com/dev

/api/entities/{entityId}/options/refresh

Re-evaluates an entity's options form given the current (partial) submission.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token for the acting user, when the Frigg app's getUserId resolves the user from an Authorization header.

Path parameters

entityIdstringRequired

The entity's id.

Example: {{entityId}}

Header parameters

x-frigg-appuseridstringOptional

Identifies the acting end user, when the Frigg app's getUserId resolves the user from this header instead of a bearer token.

Example: {{appUserId}}

x-frigg-apporgidstringOptional

Identifies the acting end user's organization (app-specific).

Example: {{appOrgId}}

Body

application/json

Other propertiesanyOptional

Responses

200

Refreshed entity options.

application/json

A dynamic options form, typically expressed as a JSON Schema plus a UI Schema consumed by the Frigg frontend.

Other propertiesanyOptional

404

Entity not found for the acting user.

post/api/entities/{entityId}/options/refresh

HTTPcURLJavaScriptPython

POST /dev/api/entities/{entityId}/options/refresh HTTP/1.1
Host: localhost:3001
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "jsonSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "uiSchema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}