Skip to main content
POST
/
webhooks
Create a new webhook
curl --request POST \
  --url https://api.onset.io/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Production Deployment Hook",
  "url": "https://api.example.com/webhooks/onset",
  "events": {
    "release.created": true,
    "release.updated": true,
    "release.deleted": false,
    "release.published": true,
    "release.scheduled": false,
    "release.reverted": false,
    "release.reacted": true,
    "release.unreacted": false,
    "milestone.created": true,
    "milestone.updated": true,
    "milestone.deleted": false,
    "milestone.upvoted": true,
    "milestone.downvoted": false,
    "milestone.archived": false,
    "milestone.unarchived": false,
    "subscriber.created": true,
    "subscriber.updated": false,
    "subscriber.deleted": false,
    "subscriber.unsubscribed": false
  }
}'
{
  "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.

Body

application/json
​
name
string
required

Webhook name

Required string length: 3 - 50
Example:

"Production Deployment Hook"

​
url
string<uri>
required

Webhook URL endpoint

Example:

"https://api.example.com/webhooks/onset"

​
events
object
required

Webhook event subscriptions

Example:
{
  "release.created": true,
  "release.updated": true,
  "release.deleted": false,
  "release.published": true,
  "release.scheduled": false,
  "release.reverted": false,
  "release.reacted": true,
  "release.unreacted": false,
  "milestone.created": true,
  "milestone.updated": true,
  "milestone.deleted": false,
  "milestone.upvoted": true,
  "milestone.downvoted": false,
  "milestone.archived": false,
  "milestone.unarchived": false,
  "subscriber.created": true,
  "subscriber.updated": false,
  "subscriber.deleted": false,
  "subscriber.unsubscribed": false
}

Response

Webhook created 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