Creatio component

The Creatio component connects our integration platform to your Creatio CRM instance via the Creatio OData API.

---

Table of Contents

• General Information
  • Description
  • Prerequisites
• Credentials
  • Registering an OAuth 2.0 Client in Creatio
  • Configuring Platform Credentials
• Environment Variables
• Triggers
  • Get New and Updated Objects Polling
• Actions
  • Delete Object By ID
  • Lookup Object By ID
  • Lookup Objects (plural)
  • Make Raw Request
  • Upsert Object
• Known Limitations & Rate Limits

General Information

The component interacts with Creatio using its OData 4.0 REST API (/0/odata/). It dynamically queries metadata (/0/odata/$metadata) to populate available entity types, date/time fields, and JSON schema properties in the integration designer.

Description

The Creatio component connects our integration platform to your Creatio CRM instance via the Creatio OData API. It provides triggers and actions to poll, search, retrieve, create, update, and delete Creatio records, as well as execute custom raw API requests.

Prerequisites

• An active Creatio CRM environment with administrative access.
• Registered OAuth 2.0 Integrated Application credentials in Creatio.

Credentials

The component uses OAuth 2.0 for secure API authentication.

Registering an OAuth 2.0 Client in Creatio

To build an integration flow, you must first register an OAuth 2.0 application in your Creatio CRM environment:

1. Sign in with a system administrator account, click the gear icon to open the System Designer page, then go to the Import and integration section and click OAuth 2.0 integrated applications.
2. Click New.
3. Set up your integration by providing the following details:
   • Name (required) – any name that helps you identify the integration.
   • Application URL – the URL of your application.
   • Description – a description of the integration.
4. Under Choose allowed OAuth flows, select On behalf of a user (authorization code).
5. Open the AUTHORIZATION CODE tab and specify:
   • Redirect URI – specify the Redirect URI as https://{your-tenant-address}/callback/oauth2, where {your-tenant-address} is the domain of your integration platform.
   • Permitted users – specify which users are permitted to use this integration to authorize access via OAuth.
6. Save the integration.

Configuring Platform Credentials

When creating a new credential on the elastic.io platform:

Environment Variables

Triggers

Get New and Updated Objects Polling

Polls Creatio for records that have been created or modified since the previous poll. Stores the highest timestamp seen in the snapshot to prevent duplicate emissions.

Configuration Fields

Input Data

None. This trigger evaluates polling timestamps based on configuration and the latest snapshot.

Output Data Examples

Emit individually (emitBehavior: emitIndividually):

{
  "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
  "Name": "John Doe",
  "CreatedOn": "2024-01-15T08:30:00Z",
  "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ModifiedOn": "2024-01-15T09:45:00Z",
  "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ProcessListeners": 0
}

Emit page (emitBehavior: emitPage):

{
  "results": [
    {
      "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
      "Name": "John Doe",
      "CreatedOn": "2024-01-15T08:30:00Z",
      "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
      "ModifiedOn": "2024-01-15T09:45:00Z",
      "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
      "ProcessListeners": 0
    }
  ]
}

Actions

Delete Object By ID

Deletes a single record from Creatio by its unique identifier (GUID).

Configuration Fields

Input Data

{
  "id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2"
}

Output Data

{
  "status": 204,
  "deletedId": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2"
}

Lookup Object By ID

Retrieves a single record from Creatio by its unique identifier (GUID).

Configuration Fields

Input Data

{
  "id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2"
}

Output Data

{
  "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
  "Name": "Acme Corporation",
  "CreatedOn": "2024-01-10T12:00:00Z",
  "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ModifiedOn": "2024-01-11T15:20:00Z",
  "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ProcessListeners": 0
}

Lookup Objects (plural)

Queries multiple records of a given object type from Creatio, automatically handling pagination via $skip and $top.

Configuration Fields

Input Data

{
  "pageSize": 50
}

Output Data Examples

Emit individually (emitBehavior: emitIndividually):

{
  "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
  "Name": "Acme Corporation",
  "CreatedOn": "2024-01-10T12:00:00Z",
  "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ModifiedOn": "2024-01-11T15:20:00Z",
  "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ProcessListeners": 0
}

Emit page (emitBehavior: emitPage):

{
  "results": [
    {
      "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
      "Name": "Acme Corporation",
      "CreatedOn": "2024-01-10T12:00:00Z",
      "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
      "ModifiedOn": "2024-01-11T15:20:00Z",
      "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
      "ProcessListeners": 0
    }
  ]
}

Make Raw Request

Executes an arbitrary HTTP request against your Creatio instance with automatic OAuth 2.0 token management.

Configuration Fields

None.

Input Data

GET Request Example:

{
  "url": "/0/odata/Contact?$top=5&$select=Id,Name,Email",
  "method": "GET"
}

POST Request Example:

{
  "url": "/0/odata/Account",
  "method": "POST",
  "data": {
    "Name": "New Corporation"
  }
}

Output Data

{
  "statusCode": 200,
  "headers": {
    "content-type": "application/json; odata.metadata=minimal"
  },
  "responseBody": {
    "@odata.context": "https://creatio.example.com/0/odata/$metadata#Account",
    "value": [
      {
        "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
        "Name": "New Corporation"
      }
    ]
  }
}

Upsert Object

Creates a new record (POST) or updates an existing record (PATCH) in Creatio.

Configuration Fields

Input Data

Create Operation (operation: Create):

{
  "Name": "Jane Smith",
  "Email": "jane.smith@example.com",
  "JobTitle": "Lead Engineer"
}

Update Operation (operation: Update):

When Update is selected, Id (or id) is mandatory.

{
  "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
  "Name": "Jane Smith",
  "Email": "jane.smith@example.com"
}

Output Data

{
  "Id": "c3e7f4c0-2f9a-4c28-98e1-5e8a3d6174a2",
  "Name": "Jane Smith",
  "Email": "jane.smith@example.com",
  "CreatedOn": "2024-01-15T08:30:00Z",
  "CreatedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ModifiedOn": "2024-01-15T09:45:00Z",
  "ModifiedById": "410006e1-ca4e-4502-a9ec-e54d922d2c00",
  "ProcessListeners": 0
}

Known Limitations & Rate Limits

1. Active Session Requirement: To authenticate credentials, you must ensure the configured OAuth application is active and valid in your Creatio CRM instance.
2. Rate Limiting (HTTP 429): If Creatio throttles requests, the component automatically waits for retriesDelay milliseconds (default: 10 seconds) and retries up to retries times (default: 5) before failing.
3. Token Expiration (HTTP 401): The component automatically refreshes expired access tokens and retries the request without failing the flow execution.
4. Page Size Limit: The maximum page size for query and polling actions is 100 records per request (automatically capped at 10 in debug/sample flows).