List integrations

  • Updated on Nov 5, 2024
  • Published on Dec 27, 2023
  • 3 minute(s) read
Prev Next
Get
/v1alpha/integrations

Returns a list of all integrations that have been created in the workspace.

Security
HTTP
Type bearer
Query parameters
type_id
string

The type of integrations to retrieve.

Responses
200

A successful response.

Expand All
object
integrations
Array of object (v1alphaIntegration)
object
id
string (uuid)

The unique identifier of the integration.

Exampled7639fb8-8037-4ce2-80e9-c50bc3345c5a
name
string

The integration name. The integration name is derived from the display name, with spaces and special characters turned into underscores, and all letters lowercased.

Examplemy_integration
display_name
string

The name of the integration as it appears in the Torq UI.

ExampleMy Integration
type_id
string

The integration type.

Examplewebhook
created_at
string (date-time)

The timestamp when the integration was created.

Example2022-03-09T08:40:18Z
created_by
string

The email address of the user who created the integration. If the integration was created automatically, the email belongs to the user whose API key was provided by the Torq integration.

Exampleuser@torq.io
last_used_at
string (date-time)

The timestamp when the integration was last used.

Example2022-03-09T08:40:18Z
details
object (v1alphaIntegrationDetails)
trigger
object (v1alphaTriggerDetails)
webhook_url
string

The integration trigger webhook (endpoint).

Examplehttps://hooks.torq.io/v1/webhooks/d7639fb8-8037-4ce2-80e9-c50bc3345c5a
sharing_data
object (v1alphaSharingData)
direction
string
  • not_shared: The resource isn't shared.
  • incoming: The resource is shared with the workspace (incoming).
  • outgoing: The resource is shared from the workspace (outgoing).
Valid values[ "not_shared", "incoming", "outgoing" ]
Default"not_shared"
workspace_ids
Array of string

If the resource is shared with the workspace (incoming) this field will hold the source workspace ID. Otherwise, if the resource is shared from the workspace (outgoing), this field will hold the IDs of the destination workspaces.

string
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object
default

An unexpected error response.

Expand All
object
code
integer (int32)
message
string
details
Array of object (protobufAny)
object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo))

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) // or ... if (any.isSameTypeAs(Foo.getDefaultInstance()))

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo any, err := anypb.New(foo) if err != nil ... foo := &pb.Foo if err := any.UnmarshalTo(foo); err != nil

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

@type
string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

property*
object additionalProperties