Skip to main content
POST
/
organizations
/
{orgId}
/
integrationconfigs
Create IntegrationConfig
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/integrationconfigs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "Bill",
  "destination": "Stripe",
  "version": 123,
  "entityId": "00000000-0000-0000-0000-000000000000",
  "destinationId": "00000000-0000-0000-0000-000000000000",
  "configData": {},
  "credentials": {
    "type": "HTTP_BASIC",
    "version": 123,
    "empty": true,
    "name": "Integration Credentials",
    "destination": "WEBHOOK"
  },
  "integrationCredentialsId": "00000000-0000-0000-0000-000000000000",
  "name": "My Integration"
}
'
{
  "id": "<string>",
  "entityType": "Bill",
  "destination": "Stripe",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "entityId": "00000000-0000-0000-0000-000000000000",
  "destinationId": "00000000-0000-0000-0000-000000000000",
  "configData": {},
  "authorized": true,
  "enabled": true,
  "triggerType": "EVENT",
  "integrationCredentialsId": "00000000-0000-0000-0000-000000000000",
  "name": "My Integration"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the organization

Body

application/json
​
entityType
string
required

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

Minimum string length: 1
Example:

"Bill"

​
destination
string
required

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

Minimum string length: 1
Example:

"Stripe"

​
version
integer<int64>

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.
​
entityId
string

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

Example:

"00000000-0000-0000-0000-000000000000"

​
destinationId
string

The unique identifier (UUID) for the integration destination.

Example:

"00000000-0000-0000-0000-000000000000"

​
configData
object

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

​
credentials
object

Base model for defining integration credentials across different types of integrations.

​
integrationCredentialsId
string
Example:

"00000000-0000-0000-0000-000000000000"

​
name
string
Example:

"My Integration"

Response

Returns the IntegrationConfig

Response containing a IntegrationConfigResponse entity.

​
id
string
required

The UUID of the entity.

​
entityType
string
required

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

Minimum string length: 1
Example:

"Bill"

​
destination
string
required

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

Minimum string length: 1
Example:

"Stripe"

​
version
integer<int64>

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.
​
dtCreated
string<date-time>

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

​
dtLastModified
string<date-time>

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

​
createdBy
string

The ID of the user who created this item.

​
lastModifiedBy
string

The ID of the user who last modified this item.

​
entityId
string

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

Example:

"00000000-0000-0000-0000-000000000000"

​
destinationId
string

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

Example:

"00000000-0000-0000-0000-000000000000"

​
configData
object

The configuration data for the integration.

​
authorized
boolean

A flag indicating whether the integration configuration is authorized.

  • TRUE - authorized.
  • FALSE - not authorized.
​
enabled
boolean

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

  • TRUE - enabled.
  • FALSE - disabled.
​
triggerType
enum<string>
deprecated

Specifies the type of trigger for the integration.

Available options:
EVENT,
SCHEDULE
​
integrationCredentialsId
string

UUID of the credentials to use for this integration

Example:

"00000000-0000-0000-0000-000000000000"

​
name
string

The name of the configuration

Example:

"My Integration"