Skip to main content

Get an integration



Returns the integration for the given UUID.


Path Parameters

    integration_uuid stringrequired

    The unique identifier of the integration.


Success. An integration is returned.

    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
    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.

    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.