Skip to main content

Get an integration

GET 

https://euwest.api.elasticpath.com/integrations/:integration_uuid

Returns the integration for the given UUID.

Request

Path Parameters

    integration_uuid stringrequired

    The unique identifier of the integration.

Responses

Success. An integration is returned.

Schema
    data object
    idstring

    The unique identifier of the integration.

    Example: 2da46671-b4c2-44ac-b133-d1221aafc77b
    typestring

    The type represents the object being returned. Always integration.

    Possible values: [integration]

    Default value: integration
    Example: integration
    namestring

    The name of the integration.

    Example: Order shipping notification
    descriptionstring

    A description of what the integration is for.

    Example: Send a shipping notification via email with discount code
    enabledboolean

    Whether the integration is enabled.

    Example: true
    integration_typestring

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

    Possible values: [webhook, aws_sqs, stomp]

    Default value: webhook
    Example: webhook
    observesstring[]

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

    configuration object
    oneOf
    links object

    Links are used to allow you to move between requests.

    selfuri

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

    Example: ?page[offset]=0&page[limit]=25
    meta object
    timestamps Timestamps

    The date and time a transaction is created.

    created_atdate-time

    The date and time an integration is updated.

    Example: 2017-07-21T17:32:28Z
    updated_atdate-time

    The date and time an integration is updated.

    Example: 2017-07-21T17:32:28Z

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/integrations/:integration_uuid");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!