Update Integration

Update an integration

PUT/integrations/{integration_uuid}

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Update Integration action (under Integrations).
Fill in the fields below, then reference the result from later steps as {{updateIntegration.response.data}}.

Request

Path parameters

integration_uuidstringrequired

The unique identifier of the integration.

Request body

Enter the body as JSON in the step's Body field.

dataobjectrequired

typestringrequired

The type represents the object being returned. Always `integration`.

One ofintegrationDefault "integration"

namestring

The name of the integration.

descriptionstring

A description of what the integration is for.

enabledboolean

Whether the integration is enabled.

is_concurrentboolean

Whether the events observed by this integration are processed concurrently. Setting this to `false` is not supported for integrations that already process events concurrently.

integration_typestring

One ofwebhookaws_sqsstompDefault "webhook"

observesarray<string>

The list of events you want to observe. See [**Observable Events**](#observable-events).

configurationobject

The content of the configuration object depends on the value of `integration_type`.

json

{
  "data": {
    "type": "integration",
    "name": "Order shipping notification",
    "description": "Send a shipping notification via email with discount code",
    "enabled": true,
    "is_concurrent": true,
    "integration_type": "webhook",
    "observes": [
      "string"
    ],
    "configuration": {}
  }
}

Response

Returns 200 with an object. Read it in later steps with {{updateIntegration.response.data.<field>}}.

dataany

linksobject

linksobject1 fields

Links are used to allow you to move between requests.

metaobject

metaobject1 fields

json

{
  "data": null,
  "links": {
    "links": {
      "self": "?page[offset]=0&page[limit]=25"
    }
  },
  "meta": {
    "meta": {
      "timestamps": {
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:32:28Z"
      }
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?