Skip to main content
GET
/
v1
/
team
/
webhooks
Get webhooks
curl --request GET \
  --url https://api.oneofnone.io/v1/team/webhooks \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "events": [
      "short_url.tapped"
    ],
    "is_enabled": true,
    "retry_count": 123,
    "timeout_ms": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Response

Successfully retrieved webhooks.

​
id
string<uuid>

Unique identifier for the webhook.

​
name
string

Display name of the webhook.

​
url
string<uri>

The URL that receives webhook payloads.

​
events
enum<string>[]

Event types this webhook is subscribed to.

Available options:
short_url.tapped,
product.registered,
activity.created,
account.created
​
is_enabled
boolean

Whether the webhook is currently active.

​
retry_count
integer

Number of retry attempts for failed deliveries.

​
timeout_ms
integer

Request timeout in milliseconds.

​
created_at
string<date-time>

When the webhook was created.

​
updated_at
string<date-time>

When the webhook was last updated.