Amplify / Client / create_webhook

create_webhook#

Amplify.Client.create_webhook(**kwargs)#

Creates a new webhook on an Amplify app.

Request Syntax

response = client.create_webhook(
    appId='string',
    branchName='string',
    description='string'
)

Parameters:

appId (string) –
[REQUIRED]

The unique ID for an Amplify app.
branchName (string) –
[REQUIRED]

The name for a branch that is part of an Amplify app.
description (string) – The description for a webhook.

Return type:

dict

Returns:

Response Syntax

{
    'webhook': {
        'webhookArn': 'string',
        'webhookId': 'string',
        'webhookUrl': 'string',
        'branchName': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –

The result structure for the create webhook request.
- webhook (dict) –
  
  Describes a webhook that connects repository events to an Amplify app.
  - webhookArn (string) –
    
    The Amazon Resource Name (ARN) for the webhook.
  - webhookId (string) –
    
    The ID of the webhook.
  - webhookUrl (string) –
    
    The URL of the webhook.
  - branchName (string) –
    
    The name for a branch that is part of an Amplify app.
  - description (string) –
    
    The description for a webhook.
  - createTime (datetime) –
    
    A timestamp of when Amplify created the webhook in your Git repository.
  - updateTime (datetime) –
    
    A timestamp of when Amplify updated the webhook in your Git repository.

Exceptions

Amplify.Client.exceptions.BadRequestException
Amplify.Client.exceptions.UnauthorizedException
Amplify.Client.exceptions.NotFoundException
Amplify.Client.exceptions.InternalFailureException
Amplify.Client.exceptions.LimitExceededException
Amplify.Client.exceptions.DependentServiceFailureException