:doc:`Amplify <../../amplify>` / Client / create_webhook

**************
create_webhook
**************



.. py:method:: Amplify.Client.create_webhook(**kwargs)

  

  Creates a new webhook on an Amplify app.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/CreateWebhook>`_  


  **Request Syntax**
  ::

    response = client.create_webhook(
        appId='string',
        branchName='string',
        description='string'
    )
    
  :type appId: string
  :param appId: **[REQUIRED]** 

    The unique ID for an Amplify app.

    

  
  :type branchName: string
  :param branchName: **[REQUIRED]** 

    The name for a branch that is part of an Amplify app.

    

  
  :type description: string
  :param description: 

    The description for a webhook.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'webhook': {
              'webhookArn': 'string',
              'webhookId': 'string',
              'webhookUrl': 'string',
              'appId': '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.

          
        

        - **appId** *(string) --* 

          The unique ID of an Amplify app.

          
        

        - **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**
  
  *   :py:class:`Amplify.Client.exceptions.BadRequestException`

  
  *   :py:class:`Amplify.Client.exceptions.UnauthorizedException`

  
  *   :py:class:`Amplify.Client.exceptions.NotFoundException`

  
  *   :py:class:`Amplify.Client.exceptions.InternalFailureException`

  
  *   :py:class:`Amplify.Client.exceptions.LimitExceededException`

  
  *   :py:class:`Amplify.Client.exceptions.DependentServiceFailureException`

  