# List All Webhooks ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/webhook_endpoints: get: summary: List All Webhooks deprecated: false description: '' tags: - API Reference/Webhooks parameters: - name: ending_before in: query description: >- A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. required: false schema: type: string - name: limit in: query description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. required: false schema: type: integer - name: starting_after in: query description: >- A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. required: false schema: type: string - name: Accept in: header description: '' required: true example: application/json schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string responses: '200': description: '' content: application/json: schema: x-apifox-overrides: {} type: object x-apifox-refs: 01GHRMG4TMB5HJWNBAJ2E9KAD7: $ref: '#/components/schemas/List' x-apifox-overrides: data: &ref_0 type: array items: x-apifox-overrides: {} type: object x-apifox-refs: 01GHRMGJADC2ZRNYCG8ZB2S494: $ref: '#/components/schemas/Webhook' x-apifox-overrides: secret: null x-apifox-orders: - 01GHRMGJADC2ZRNYCG8ZB2S494 properties: id: type: string description: >- Unique identifier for the object, like "we_xxxxx" object: type: string title: '' default: '"webhook_endpoint"' description: '**"webhook_endpoint"** ' api_version: type: string description: >- The API version events are rendered as for this webhook endpoint. created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. description: type: string description: >- An optional description of what the webhook is used for. enabled_events: type: array items: type: string description: 'The list of events to enable for this endpoint. ' livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. metadata: type: object properties: {} x-apifox-orders: [] description: >- Set of key-value pairs that you can attach to an object. x-apifox-ignore-properties: [] status: type: string description: >- The status of the webhook. It can be enabled or disabled. url: type: string description: The URL of the webhook endpoint. x-apifox-ignore-properties: - id - object - api_version - created - description - enabled_events - livemode - metadata - status - url required: - data x-apifox-orders: - 01GHRMG4TMB5HJWNBAJ2E9KAD7 properties: object: type: string default: '"list"' url: type: string has_more: type: boolean data: *ref_0 required: - data x-apifox-ignore-properties: - object - url - has_more - data example: object: list url: /v1/webhook_endpoints has_more: false data: - id: we_XXXXXXXXX object: webhook_endpoint api_version: null application: null created: 1668347385 description: This is my webhook enabled_events: - charge.failed - charge.succeeded livemode: false metadata: {} status: enabled url: https://example.com/my/webhook/endpoint headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Webhooks x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-42648473-run components: schemas: List: type: object properties: object: type: string default: '"list"' url: type: string has_more: type: boolean data: type: array items: type: object properties: id: type: string object: type: string api_version: type: 'null' application: type: 'null' created: type: integer description: type: string enabled_events: type: array items: type: string livemode: type: boolean metadata: type: object properties: {} x-apifox-orders: [] x-apifox-ignore-properties: [] status: type: string url: type: string x-apifox-orders: - id - object - api_version - application - created - description - enabled_events - livemode - metadata - status - url x-apifox-ignore-properties: [] x-apifox-orders: - object - url - has_more - data x-apifox-ignore-properties: [] x-apifox-folder: '' Webhook: type: object properties: id: type: string description: Unique identifier for the object, like "we_xxxxx" object: type: string title: '' default: '"webhook_endpoint"' description: '**"webhook_endpoint"** ' api_version: type: string description: The API version events are rendered as for this webhook endpoint. created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. description: type: string description: An optional description of what the webhook is used for. enabled_events: type: array items: type: string description: 'The list of events to enable for this endpoint. ' livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. metadata: type: object properties: {} x-apifox-orders: [] description: 'Set of key-value pairs that you can attach to an object. ' x-apifox-ignore-properties: [] status: type: string description: The status of the webhook. It can be enabled or disabled. secret: type: string description: >- The endpoint’s secret, used to generate webhook signatures. Only returned at creation. url: type: string description: The URL of the webhook endpoint. x-apifox-orders: - id - object - api_version - created - description - enabled_events - livemode - metadata - status - secret - url x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```