# List Webhooks

Retrieve a list of .

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /webhooks
Version: 2022-02-01
Security: BasicAuth

## Query parameters:

  - `limit` (integer)
    The numbers of items to return.
    Example: 3

  - `after_cursor` (string)
    Return every resource created after the cursor value.

  - `before_cursor` (string)
    Return every resource created before the cursor value.

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

  - `_embedded` (object)
    List of  objects.

  - `_embedded.webhooks` (array)
    objects.

  - `_embedded.webhooks.id` (string)
    The ID of the  resource.
    Example: "WHxxxxxxxxxxxxxxxxxx"

  - `_embedded.webhooks.created_at` (string)
    Timestamp of when the object was created.

  - `_embedded.webhooks.updated_at` (string)
    Timestamp of when the object was last updated.

  - `_embedded.webhooks.application` (string)
    The ID of the  resource the  was created under.

  - `_embedded.webhooks.authentication` (object)
    The [authentication settings](/additional-resources/developers/webhooks/integrating-into-webhooks#authenticating-webhooks) that are used to send webhook events.

  - `_embedded.webhooks.authentication.type` (string)
    The type of authentication the webhook will use:
- NONE: No authentication will be used.
- BASIC: Basic authentication.
- BEARER: Oauth2's Bearer Token.
    Enum: "NONE", "BASIC", "BEARER"

  - `_embedded.webhooks.enabled` (boolean)
    Details if the  is enabled:true: Events are being sent to the .false: Events are not being sent.

  - `_embedded.webhooks.enabled_events` (array)
    A list of events the [webhook is explicitly enabled for](/additional-resources/developers/webhooks/integrating-into-webhooks#filtering-webhooks).

  - `_embedded.webhooks.enabled_events.entity` (string)
    The entity type for the enabled event, either  or . There can only be one enabled event object for a given entity.

  - `_embedded.webhooks.enabled_events.types` (array)
    A list of event types you want to receive for the specified . 

- When  is set to , the acceptable value is . 
- When  is set to , the acceptable values are  and .

  - `_embedded.webhooks.is_accepting_events` (boolean)
    Whether the webhook is accepting events.

  - `_embedded.webhooks.nickname` (string)
    A human-readable name for the webhook.

  - `_embedded.webhooks.previous_secret_expires_at` (string,null)
    The time when the previous  will expire. This is  when the webhook is initially created.

  - `_embedded.webhooks.secret_signing_key` (string,null)
    The secret signing key that gets used to verify webhook events.

  - `_embedded.webhooks.url` (string)
    The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).

  - `_embedded.webhooks._links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_embedded.webhooks._links.application` (object)
    Link to the  the resource was created under.

  - `_embedded.webhooks._links.application.href` (string)

  - `_embedded.webhooks._links.self` (object)
    Link to the resource that was used in the request.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 406 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)