Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://api.onset.io/v1/webhooks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "events": {
      "release.created": true,
      "release.updated": true,
      "release.deleted": false,
      "release.published": true,
      "release.scheduled": false,
      "release.reverted": false,
      "release.reacted": false,
      "release.unreacted": false,
      "milestone.created": true,
      "milestone.updated": true,
      "milestone.deleted": false,
      "milestone.upvoted": false,
      "milestone.downvoted": false,
      "milestone.archived": false,
      "milestone.unarchived": false,
      "subscriber.created": false,
      "subscriber.updated": false,
      "subscriber.deleted": false,
      "subscriber.unsubscribed": false
    },
    "last_triggered_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 1000
​
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100

Response

List of webhooks retrieved successfully

​
id
string

Unique webhook identifier

​
name
string

Webhook name

​
url
string<uri>

Webhook URL endpoint

​
events
object

Webhook event subscriptions

Example:
{
  "release.created": true,
  "release.updated": true,
  "release.deleted": false,
  "release.published": true,
  "release.scheduled": false,
  "release.reverted": false,
  "release.reacted": false,
  "release.unreacted": false,
  "milestone.created": true,
  "milestone.updated": true,
  "milestone.deleted": false,
  "milestone.upvoted": false,
  "milestone.downvoted": false,
  "milestone.archived": false,
  "milestone.unarchived": false,
  "subscriber.created": false,
  "subscriber.updated": false,
  "subscriber.deleted": false,
  "subscriber.unsubscribed": false
}
​
last_triggered_at
string<date-time> | null

When the webhook was last triggered

​
created_at
string<date-time>

When the webhook was created

​
updated_at
string<date-time>

When the webhook was last updated

⌘I