Skip to main content

List Subscriptions

GET 

/trigger-subscriptions

Gets a list of all trigger subscriptions.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq

    triggerId: eq

    type: eq, le

    Example: id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: triggerId, triggerName

    Example: triggerName

Responses

List of subscriptions.

Schema

  • Array [

  • id stringrequired

    Subscription ID.

    name stringrequired

    Subscription name.

    description string

    Subscription description.

    triggerId stringrequired

    ID of trigger subscribed to.

    triggerName stringrequired

    Trigger name of trigger subscribed to.

    type SubscriptionType (string)required

    Possible values: [HTTP, EVENTBRIDGE, INLINE, SCRIPT, WORKFLOW]

    Subscription type. NOTE If type is EVENTBRIDGE, then eventBridgeConfig is required. If type is HTTP, then httpConfig is required.

    responseDeadline string

    Default value: PT1H

    Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format.

    httpConfig

    object

    Config required if HTTP subscription type is used.

    url stringrequired

    URL of the external/custom integration.

    httpDispatchMode HttpDispatchMode (string)required

    Possible values: [SYNC, ASYNC, DYNAMIC]

    HTTP response modes, i.e. SYNC, ASYNC, or DYNAMIC.

    httpAuthenticationType HttpAuthenticationType (string)

    Possible values: [NO_AUTH, BASIC_AUTH, BEARER_TOKEN]

    Default value: NO_AUTH

    Defines the HTTP Authentication type. Additional values may be added in the future.

    If NO_AUTH is selected, no extra information will be in HttpConfig.

    If BASIC_AUTH is selected, HttpConfig will include BasicAuthConfig with Username and Password as strings.

    If BEARER_TOKEN is selected, HttpConfig will include BearerTokenAuthConfig with Token as string.

    basicAuthConfig

    object

    nullable

    Config required if BASIC_AUTH is used.

    userName string

    The username to authenticate.

    password stringnullable

    The password to authenticate. On response, this field is set to null as to not return secrets.

    bearerTokenAuthConfig

    object

    nullable

    Config required if BEARER_TOKEN authentication is used. On response, this field is set to null as to not return secrets.

    bearerToken stringnullable

    Bearer token

    eventBridgeConfig

    object

    Config required if EVENTBRIDGE subscription type is used.

    awsAccount stringrequired

    AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource.

    awsRegion stringrequired

    AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values.

    enabled booleanrequired

    Default value: true

    Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option.

    filter string

    JSONPath filter to conditionally invoke trigger when expression evaluates to true.

  • ]

Loading...