Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateChimeWebhookConfiguration

Creates an AWS Chatbot configuration for Amazon Chime.

Request Syntax


POST /create-chime-webhook-configuration HTTP/1.1
Content-type: application/json

{
   "ConfigurationName": "string",
   "IamRoleArn": "string",
   "LoggingLevel": "string",
   "SnsTopicArns": [ "string" ],
   "WebhookDescription": "string",
   "WebhookUrl": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ConfigurationName

The name of the configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[A-Za-z0-9-_]+$

Required: Yes

IamRoleArn

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1224.

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

LoggingLevel

Logging levels include ERROR, INFO, or NONE.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 5.

Pattern: ^(ERROR|INFO|NONE)$

Required: No

SnsTopicArns

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

Type: Array of strings

Length Constraints: Minimum length of 12. Maximum length of 1224.

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Required: Yes

WebhookDescription

A description of the webhook. We recommend using the convention RoomName/WebhookName.

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

WebhookUrl

The URL for the Amazon Chime webhook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^https://hooks\.chime\.aws/incomingwebhooks/[A-Za-z0-9\-]+?\?token=[A-Za-z0-9\-]+$

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "WebhookConfiguration": { 
      "ChatConfigurationArn": "string",
      "ConfigurationName": "string",
      "IamRoleArn": "string",
      "LoggingLevel": "string",
      "SnsTopicArns": [ "string" ],
      "WebhookDescription": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

WebhookConfiguration

An Amazon Chime webhook configuration.

Type: ChimeWebhookConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was an issue processing your request.

HTTP Status Code: 409

CreateChimeWebhookConfigurationException

We can’t process your request right now because of a server issue. Try again later.

HTTP Status Code: 500

InvalidParameterException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

InvalidRequestException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

LimitExceededException

You have exceeded a service limit for AWS Chatbot.

HTTP Status Code: 403