Skip to main content
POST
/
incoming-webhooks
Create a new incoming webhook
curl --request POST \
  --url https://api.onset.io/v1/incoming-webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "New release trigger",
  "type": "RELEASE"
}'
{
  "id": "iw_01hf8k4x7n9m2p3q5r8s9t0v1w",
  "name": "New release trigger",
  "type": "RELEASE",
  "isEnabled": true,
  "url": "https://hooks.onset.io/v1/XXXX/XXX",
  "lastTriggeredAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "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

Incoming webhook name

Example:

"New release trigger"

​
type
enum<string>
required

Incoming webhook type

Available options:
RELEASE,
MILESTONE,
SUBSCRIBER

Response

Incoming webhook created successfully

​
id
string

Unique incoming webhook identifier

Example:

"iw_01hf8k4x7n9m2p3q5r8s9t0v1w"

​
name
string

Incoming webhook name

Example:

"New release trigger"

​
type
enum<string>

Incoming webhook type

Available options:
RELEASE,
MILESTONE,
SUBSCRIBER
Example:

"RELEASE"

​
isEnabled
boolean

Indicates whether the incoming webhook is enabled

Example:

true

​
url
string<uri>

Incoming webhook URL endpoint

Example:

"https://hooks.onset.io/v1/XXXX/XXX"

​
lastTriggeredAt
string<date-time> | null

Timestamp of the last successful trigger

​
createdAt
string<date-time>

Creation timestamp

​
updatedAt
string<date-time>

Last update timestamp

⌘I