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

application/json

Body

required

name stringrequired

Subscription name.

description string

Subscription description.

triggerId stringrequired

ID of trigger subscribed to.

type SubscriptionTyperequired

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 HttpDispatchModerequired

Possible values: [SYNC, ASYNC, DYNAMIC]

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

httpAuthenticationType HttpAuthenticationType

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 objectnullable

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 objectnullable

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

201

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

application/json

Schema

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 SubscriptionTyperequired

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 stringrequired

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 HttpDispatchModerequired

Possible values: [SYNC, ASYNC, DYNAMIC]

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

httpAuthenticationType HttpAuthenticationType

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 objectnullable

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 objectnullable

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.

Example (from schema)

{
  "id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
  "name": "Access request subscription",
  "description": "Access requested to site xyz",
  "triggerId": "idn:access-requested",
  "triggerName": "Access Requested",
  "type": "HTTP",
  "responseDeadline": "PT1H",
  "httpConfig": {
    "url": "https://www.example.com",
    "httpDispatchMode": "SYNC",
    "httpAuthenticationType": "BASIC_AUTH",
    "basicAuthConfig": {
      "userName": "[email protected]",
      "password": null
    },
    "bearerTokenAuthConfig": {
      "bearerToken": null
    }
  },
  "eventBridgeConfig": {
    "awsAccount": "123456789012",
    "awsRegion": "us-west-1"
  },
  "enabled": true,
  "filter": "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
Possible values: [DEFAULT, REQUEST, null]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text string
Actual text of the error message in the indicated locale.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...