Create an integration

POST 
/integrations

Create an integration.

Request

application/json

Body

data IntegrationCreaterequired

type stringrequired

Possible values: [integration]

Default value: integration

The type represents the object being returned. Always integration.

name stringrequired

The name of the integration.

description string

A description of what the integration is for.

enabled boolean

Whether the integration is enabled.

integration_type stringrequired

Possible values: [webhook, aws_sqs, stomp]

Default value: webhook

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

observes string[]

The list of events you want to observe. See Observable Events.

configuration object required

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

oneOf

AWSSQSConfigurationObject

url stringrequired

The required SQS queue URL.

aws_access_key_id stringrequired

The required AWS access key ID.

aws_secret_access_key stringrequired

The required AWS secret key ID.

region stringrequired

The required AWS region.

WebhookConfigurationObject

url stringrequired

A required URL that the integration fires.

secret_key string

An optional header. Useful to authenticate the response came from Elastic Path. This is sent as X-MOLTIN-SECRET-KEY.

STOMPConfigurationObject

username string

The username used to authenticate against a STOMP server.

password string

The password used to authenticate against a STOMP server.

destination string

The destination in the messaging queuing system.

addresses string[]

The addresses that correspond with the destination name.

Responses

200

Success. Integration created.

application/json

Schema

Schema

data object

id string

The unique identifier of the integration.

type string

Possible values: [integration]

Default value: integration

The type represents the object being returned. Always integration.

name string

The name of the integration.

description string

A description of what the integration is for.

enabled boolean

Whether the integration is enabled.

integration_type string

Possible values: [webhook, aws_sqs, stomp]

Default value: webhook

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

observes string[]

The list of events you want to observe. See Observable Events.

configuration object

oneOf

AWSSQSConfigurationObject

url stringrequired

The required SQS queue URL.

aws_access_key_id stringrequired

The required AWS access key ID.

aws_secret_access_key stringrequired

The required AWS secret key ID.

region stringrequired

The required AWS region.

WebhookConfigurationObject

url stringrequired

A required URL that the integration fires.

secret_key string

An optional header. Useful to authenticate the response came from Elastic Path. This is sent as X-MOLTIN-SECRET-KEY.

STOMPConfigurationObject

username string

The username used to authenticate against a STOMP server.

password string

The password used to authenticate against a STOMP server.

destination string

The destination in the messaging queuing system.

addresses string[]

The addresses that correspond with the destination name.

links object

Links are used to allow you to move between requests.

self uri

Single entities use a self parameter with a link to that specific resource.

meta object

timestamps Timestamps

The date and time a transaction is created.

created_at date-time

The date and time an integration is updated.

updated_at date-time

The date and time an integration is updated.

Example (from schema)

{
  "data": {
    "id": "2da46671-b4c2-44ac-b133-d1221aafc77b",
    "type": "integration",
    "name": "Order shipping notification",
    "description": "Send a shipping notification via email with discount code",
    "enabled": true,
    "integration_type": "webhook",
    "observes": [
      "string"
    ],
    "configuration": {
      "url": "https://sqs.eu-west-1.amazonaws.com/123456789/epcc-external-queue",
      "aws_access_key_id": "****************JIMB",
      "aws_secret_access_key": "************************************HK4o",
      "region": "eu-west-1"
    },
    "links": {
      "self": "?page[offset]=0&page[limit]=25"
    },
    "meta": {
      "timestamps": {
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:32:28Z"
      }
    }
  }
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status int
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": 400,
      "detail": "Your request was invalid"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors ErrorBody[]required
Array [
status int
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred."
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": 500
    }
  ]
}

Loading...