List All Webhooks - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic YWRtaW46MTIzNDU2

Query Params

ending_before

string

optional

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.

limit

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after

string

optional

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.

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://apitest.wooshpay.com/v1/webhook_endpoints?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues'

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {10}]

required

id

string

optional

Unique identifier for the object, like "we_xxxxx"

object

string

optional

"webhook_endpoint"

Default:

"webhook_endpoint"

api_version

string

optional

The API version events are rendered as for this webhook endpoint.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

description

string

optional

An optional description of what the webhook is used for.

enabled_events

array[string]

optional

The list of events to enable for this endpoint.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

status

string

optional

The status of the webhook. It can be enabled or disabled.

url

string

optional

The URL of the webhook endpoint.

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"
    }
  ]
}