Skip to main content

Create a Subscription

POST 

/trigger-subscriptions

This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required:

  • HTTP subscriptions require httpConfig
  • EventBridge subscriptions require eventBridgeConfig

Request

Body

required

    name stringrequired

    Subscription name.

    description string

    Subscription description.

    triggerId stringrequired

    ID 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 boolean

    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.

Responses

New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription.

Schema

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