younifyd
Menu

Create Integration

Create an integration

POST/integrations

Use it in a workflow

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

Request

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"

namestringrequired

The name of the integration.

descriptionstring

A description of what the integration is for.

enabledboolean

Whether the integration is enabled.

integration_typestringrequired

Specifies how the event is delivered. The options are `webhook`, `aws-sqs`, or `stomp`.

One ofwebhookaws_sqsstompDefault "webhook"

observesarray<string>

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

configurationobjectrequired

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

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

Response

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

dataany
json
{
  "data": null
}

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