POST

/subscribe

http://codestar-notifications.{region}.amazonaws.com/subscribe

Creates an association between a notification rule and an Chatbot topic or Chatbot client so that the associated target can receive notifications when the events described in the rule are triggered.

Access Token Required: API Key

Body Params

Arnstringrequired

The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

Targetobjectrequired

Information about the Chatbot topics or Chatbot clients associated with a notification rule.

ClientRequestTokenstring

An enumeration token that, when provided in a request, returns the next batch of the results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codestar-notifications.{region}.amazonaws.com/subscribe' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}