Subscriptions

Use to manage notifications subscriptions.

Get current users subscriptions

SecuritybearerAuth

Responses

200

A Subscription

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

get/api/v1/subscriptions

Response samples

application/json

[{"id": 123,
"events": [{"category": "cat1",
"types": ["type1",
"type2"
]
},
{"category": "cat2",
"types": ["type3",
"type4"
]
}
],
"channels": ["email",
"slack1"
]
}
]

Create user subscription

SecuritybearerAuth

Request

Request Body schema: application/json

required	Array of objects (SubscriptionEvents)
channels required	Array of strings
id required	string

Responses

200

Subscription created successfully

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

post/api/v1/subscriptions

Request samples

Payload

application/json

{"id": 123,
"events": [{"category": "cat1",
"types": ["type1",
"type2"
]
},
{"category": "cat2",
"types": ["type3",
"type4"
]
}
],
"channels": ["email",
"slack1"
]
}

Response samples

application/json

{"id": 123,
"events": [{"category": "cat1",
"types": ["type1",
"type2"
]
},
{"category": "cat2",
"types": ["type3",
"type4"
]
}
],
"channels": ["email",
"slack1"
]
}

Update user subscription

SecuritybearerAuth

Request

path Parameters

id

required

string

Subscription id

Request Body schema: application/json

	Array of objects (SubscriptionEvents)
channels	Array of strings

Responses

200

Subscription updated successfully

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

put/api/v1/subscriptions/{id}

Request samples

Payload

application/json

{"events": [{"category": "cat1",
"types": ["type1",
"type2"
]
},
{"category": "cat2",
"types": ["type3",
"type4"
]
}
],
"channels": ["email",
"slack1"
]
}

Response samples

application/json

{"id": 123,
"events": [{"category": "cat1",
"types": ["type1",
"type2"
]
},
{"category": "cat2",
"types": ["type3",
"type4"
]
}
],
"channels": ["email",
"slack1"
]
}

Delete user subscription

SecuritybearerAuth

Request

path Parameters

id

required

string

Subscription id

Responses

204

The resource was deleted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

501

unexpected error

503

unexpected error

delete/api/v1/subscriptions/{id}

Response samples

application/json

{"code": 400,
"message": "Required parameter is missing"
}