Integration Actions

Create new integration action

Creates a new integration action

post/managed_integrations/public/{managed_integration_uuid}/integration_actions

Request

Path parameters

managed_integration_uuidstring required

The unique identifier for the managed integration whose integration action you would like

Request body

typestring

the type of action being requested

entity_idstring

The identifier for the entity that should be processed as part of the action. For example, process order 8

Example request

{
  "type": "export_order",
  "entity_id": "8"
}

Response

Successful response

uuidstring uuid
typestring

the type of action being requested

createdstring date-time
updatedstring date-time
current_record_countinteger
last_checkinstring date-time nullable
related_objectstring nullable
related_object_typestring
statusstring

The current status of the action

status_messagestring
entity_idstring

The identifier for the entity that should be processed as part of the action. For example, process order 8

Example response

{
  "type": "export_order",
  "status": "in_progress",
  "status_message": "Order 8 is currently being processed",
  "entity_id": "8"
}

Changes

No recorded changes to this operation across all 1 revision of this API.