List Integrations

GET /event-system/integrations
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/event-system/integrations

Returns a list of Integrations

query Parameters
Arrow
Name
Description
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ integration ]
An array of all created items.
Integration
Name
Description
actions[ action ]
Array of integration actions objects.
Action
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed Action description.


Example: Creates a Ticket
enginestring
Action engine.


Example: email

Possible values: http | email
idstring
The ID of the action, generated by Ocamba API.


Example: 1014
integration_idstring
The ID of the integration.


Example: 10014
itemstring
The Action item.


Example: Ticket
namestring
The Action name.


Example: Create Ticket
propertiesproperties
The Action properties map.
Properties
Name
Description
labellabel
The key of properties maps.


Example: label
Label
Name
Description
descriptionstring
The Designer description.


Example: design description
keystring
The Designer key.


Example: url
requiredboolean
The Designer required.


Example: true
typestring
The Designer type.


Example: string
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
audiencestring
Integration audiece.


Example: public

Possible values: private | public
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed integration description.


Example: Description of integration
events[ event ]
Array of integration events objects.
Event
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed Event description.


Example: Creates a Event
idstring
The ID of the event, generated by Ocamba API.


Example: 1026
integration_idstring
The ID of the integration.


Example: 10002
itemstring
The Event item.


Example: item
namestring
The Event name.


Example: Create Event
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
homepagestring (url)
The integration homepage.


Example: https://delsystems.net/index.htm
idstring
The ID of the dashboard, generated by Ocamba API.


Example: 10014
logostring (url)
The integration icon.


Example: https://www.google.com/search?q=logo&rlz=1C5CHFA_enRS985RS988
namestring
The integration name.


Example: Integration
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
versionstring
The integration version.


Example: 1.1.10
totalnumber (integer)
A total number of items.


Example: 12
tip
1 Searchable field is name.
2 Sortable fields are name and status.
3 Filterable fields are id, name, status, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "10000",
      "name": "Ocamba Hood",
      "description": "Hood app from Ocamba platform",
      "homepage": "https://ocamba.com",
      "version": "1.0.0",
      "audience": "public",
      "create_time": "2022-06-30 07:55:49",
      "update_time": "2022-06-30 07:55:49",
      "events": [
        {
          "id": "1000",
          "integration_id": "10000",
          "name": "Push subscription",
          "item": "Push",
          "description": "Triggers when user subscribes",
          "operation": {
            "output_params": [
                {
                    "key": "user_id",
                    "type": "string"
                }
                {
                    "key": "app_name",
                    "type": "string"
                },
                {
                    "key": "tag_id",
                    "type": "string"
                }
            ]
          },
          "create_time": "2022-06-30 08:23:34",
          "update_time": "2022-07-04 10:47:30"
        }
      ],
      "actions": [
        {
          "id": "1010",
          "integration_id": "10000",
          "name": "Send Adex notification",
          "item": "Push",
          "description": "Send webpush to a subscribed user on Ocamba hood tag",
          "engine": "api",
          "operation": {
            "input_params": {
                "user_id": {
                    "key": "User id",
                    "type": "string",
                    "description": "user from ocamba platform, use from event only",
                    "required": true,
                    "in": "body"
                },
                "zone_id": {
                    "key": "Zone id",
                    "type": "string",
                    "description": "Zone id from Ocamba adex",
                    "required": true,
                    "in": "body"
                }
              }
          },
          "create_time": "2022-06-30 08:25:18"
        }
      ]
    } 
  ] 
}

{
  "total": 12,
  "items": [
    {
      "id": "10014",
      "name": "Integration",
      "description": "Description of integration",
      "logo": "https://www.google.com/search?q=logo&rlz=1C5CHFA_enRS985RS988",
      "homepage": "https://delsystems.net/index.htm",
      "version": "1.1.10",
      "audience": "public",
      "events": [
        {
          "id": "1026",
          "integration_id": "10002",
          "name": "Create Event",
          "item": "item",
          "description": "Creates a Event",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "actions": [
        {
          "id": "1014",
          "integration_id": "10014",
          "name": "Create Ticket",
          "item": "Ticket",
          "engine": "email",
          "properties": {
            "label": {
              "key": "url",
              "type": "string",
              "description": "design description",
              "required": true
            }
          },
          "description": "Creates a Ticket",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}