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

*************
list_webhooks
*************



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

  

  Returns a list of webhooks for an Amplify app.

  

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


  **Request Syntax**
  ::

    response = client.list_webhooks(
        appId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type appId: string
  :param appId: **[REQUIRED]** 

    The unique ID for an Amplify app.

    

  
  :type nextToken: string
  :param nextToken: 

    A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of records to list in a single response.

    

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

    
    ::

      {
          'webhooks': [
              {
                  'webhookArn': 'string',
                  'webhookId': 'string',
                  'webhookUrl': 'string',
                  'appId': 'string',
                  'branchName': 'string',
                  'description': 'string',
                  'createTime': datetime(2015, 1, 1),
                  'updateTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The result structure for the list webhooks request.

      
      

      - **webhooks** *(list) --* 

        A list of webhooks.

        
        

        - *(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.

            
      
    
      

      - **nextToken** *(string) --* 

        A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

        
  
  **Exceptions**
  
  *   :py:class:`Amplify.Client.exceptions.BadRequestException`

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

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

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

  