Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Integrations

Create IntegrationConfig

Set the integration configuration for the entity.

post/organizations/{orgId}/integrationconfigs

Path parameters

orgIdstring required

UUID of the organization

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
entityTypestring required

Specifies the type of entity for which the integration configuration is being updated. Must be a valid alphanumeric string.

entityIdstring

The unique identifier (UUID) of the entity. This field is used to specify which entity's integration configuration you're updating.

destinationstring required

Denotes the integration destination. This field identifies the target platform or service for the integration.

destinationIdstring

The unique identifier (UUID) for the integration destination.

configDataobject

A flexible object to include any additional configuration data specific to the integration.

integrationCredentialsIdstring
namestring

Example request

{
  "entityType": "Bill",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "destination": "Stripe",
  "destinationId": "00000000-0000-0000-0000-000000000000",
  "integrationCredentialsId": "00000000-0000-0000-0000-000000000000",
  "name": "My Integration"
}

Response

Returns the IntegrationConfig

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

entityTypestring required

The type of entity the integration is for (e.g. Bill).

entityIdstring

The unique identifier (UUID) of the entity this integration is for (e.g. the ID of a notification configuration. Optional.)

destinationstring required

The type of destination (e.g. Netsuite, webhooks).

destinationIdstring

The unique identifier (UUID) of the entity the integration is for.

configDataobject

Configuration data for the integration

authorizedboolean

A flag indicating whether the integration configuration is authorized.

  • TRUE - authorized.
  • FALSE - not authorized.
enabledboolean

A flag indicating whether the integration configuration is currently enabled or disabled.

  • TRUE - enabled.
  • FALSE - disabled.
triggerType'EVENT' | 'SCHEDULE'

Specifies the type of trigger for the integration.

integrationCredentialsIdstring

UUID of the credentials to use for this integration

namestring

The name of the configuration

Example response

{
  "entityType": "Bill",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "destination": "Stripe",
  "destinationId": "00000000-0000-0000-0000-000000000000",
  "integrationCredentialsId": "00000000-0000-0000-0000-000000000000",
  "name": "My Integration"
}