Overview
Manages Singularity webhooks.
DELETE /api/webhooks/{webhookId}
Delete a specific webhook.
Parameters
path
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | true | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
string
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/task/{webhookId}
Retrieve a list of queued task updates for a specific webhook.
Parameters
path
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | true | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
List[SingularityTaskHistoryUpdate]
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/task
Retrieve a list of queued task updates for a specific webhook.
Parameters
query
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | false | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
List[SingularityTaskHistoryUpdate]
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/summary
Retrieve a summary of each active webhook
Parameters
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
List[SingularityWebhookSummary]
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/request/{webhookId}
Retrieve a list of queued request updates for a specific webhook.
Parameters
path
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | true | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
List[SingularityRequestHistory]
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/request
Retrieve a list of queued request updates for a specific webhook.
Parameters
query
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | false | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
List[SingularityRequestHistory]
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/deploy/{webhookId}
Retrieve a list of queued deploy updates for a specific webhook.
Parameters
path
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | true | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks/deploy
Retrieve a list of queued deploy updates for a specific webhook.
Parameters
query
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | false | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
GET /api/webhooks
Retrieve a list of active webhooks.
Parameters
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
POST /api/webhooks
Add a new webhook.
Parameters
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityWebhook</a> |
Response
string
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |
DELETE /api/webhooks
Delete a specific webhook.
Parameters
query
Parameter | Required | Description | Data Type |
---|---|---|---|
webhookId | false | string |
body
Parameter | Required | Description | Data Type |
---|---|---|---|
body | false | SingularityUser</a> |
Response
string
Errors
Status Code | Reason | Response Model |
---|---|---|
- | - | - |