curl --request POST \
--url https://api-canary.watchdog.no/v1/check-selections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"selection": {
"scope": {
"type": "agreements",
"filter": {
"mine": true,
"team_ids": [
"<string>"
],
"ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"renewal_action_kinds": [],
"renewal_deadline_from": "<string>",
"renewal_deadline_through": "<string>",
"search": "<string>",
"statuses": [],
"supplier_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"recipient_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"has_alert_verdicts": [],
"has_alert_credited": true,
"effective_from": "<string>",
"effective_through": "<string>",
"expiration_from": "<string>",
"expiration_through": "<string>",
"valid_on": "<string>"
},
"agreement_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"excluded_agreement_ids": []
},
"mode": "outstanding",
"invoices": {
"type": "all",
"excluded_invoice_ids": []
},
"issued_from": "2023-12-25",
"issued_through": "2023-12-25"
},
"fingerprint": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
selection: {
scope: {
type: 'agreements',
filter: {
mine: true,
team_ids: ['<string>'],
ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
renewal_action_kinds: [],
renewal_deadline_from: '<string>',
renewal_deadline_through: '<string>',
search: '<string>',
statuses: [],
supplier_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
recipient_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
tag_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
has_alert_verdicts: [],
has_alert_credited: true,
effective_from: '<string>',
effective_through: '<string>',
expiration_from: '<string>',
expiration_through: '<string>',
valid_on: '<string>'
},
agreement_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
excluded_agreement_ids: []
},
mode: 'outstanding',
invoices: {type: 'all', excluded_invoice_ids: []},
issued_from: '2023-12-25',
issued_through: '2023-12-25'
},
fingerprint: '<string>'
})
};
fetch('https://api-canary.watchdog.no/v1/check-selections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-canary.watchdog.no/v1/check-selections"
payload = {
"selection": {
"scope": {
"type": "agreements",
"filter": {
"mine": True,
"team_ids": ["<string>"],
"ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"renewal_action_kinds": [],
"renewal_deadline_from": "<string>",
"renewal_deadline_through": "<string>",
"search": "<string>",
"statuses": [],
"supplier_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"recipient_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"tag_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"has_alert_verdicts": [],
"has_alert_credited": True,
"effective_from": "<string>",
"effective_through": "<string>",
"expiration_from": "<string>",
"expiration_through": "<string>",
"valid_on": "<string>"
},
"agreement_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"excluded_agreement_ids": []
},
"mode": "outstanding",
"invoices": {
"type": "all",
"excluded_invoice_ids": []
},
"issued_from": "2023-12-25",
"issued_through": "2023-12-25"
},
"fingerprint": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"agreements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"check_count": 123
}
],
"mode": "outstanding",
"workflow_run_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"invoice_count": 123,
"check_count": 123,
"deleted_alert_count": 123,
"kept_alert_count": 123,
"kept_user_alert_count": 123,
"cancelled_check_count": 123
}{
"agreements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"check_count": 123
}
],
"mode": "outstanding",
"workflow_run_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"invoice_count": 123,
"check_count": 123,
"deleted_alert_count": 123,
"kept_alert_count": 123,
"kept_user_alert_count": 123,
"cancelled_check_count": 123
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Stale preview, oversized selection, conflicting request key or no eligible work. Nothing new started.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Dispatch was not confirmed for every run. Read the receipt at Location; do not submit a fresh key.",
"request_id": "req_example"
}
}Confirm checks or reset their selected pairs
Requires an unchanged preview fingerprint. Supply Idempotency-Key to safely replay after a timeout or lost response. Admission is all-or-nothing and capped at 5,000 pairs and 50 check runs. One durable workflow per agreement. Existing results remain until successful replacement; reset cancels unfinished work and deletes only unprotected alerts, without starting checks. The receipt retains the original selection and all run IDs. Replay never creates new work.
curl --request POST \
--url https://api-canary.watchdog.no/v1/check-selections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"selection": {
"scope": {
"type": "agreements",
"filter": {
"mine": true,
"team_ids": [
"<string>"
],
"ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"renewal_action_kinds": [],
"renewal_deadline_from": "<string>",
"renewal_deadline_through": "<string>",
"search": "<string>",
"statuses": [],
"supplier_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"recipient_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"tag_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"has_alert_verdicts": [],
"has_alert_credited": true,
"effective_from": "<string>",
"effective_through": "<string>",
"expiration_from": "<string>",
"expiration_through": "<string>",
"valid_on": "<string>"
},
"agreement_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"excluded_agreement_ids": []
},
"mode": "outstanding",
"invoices": {
"type": "all",
"excluded_invoice_ids": []
},
"issued_from": "2023-12-25",
"issued_through": "2023-12-25"
},
"fingerprint": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
selection: {
scope: {
type: 'agreements',
filter: {
mine: true,
team_ids: ['<string>'],
ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
renewal_action_kinds: [],
renewal_deadline_from: '<string>',
renewal_deadline_through: '<string>',
search: '<string>',
statuses: [],
supplier_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
recipient_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
tag_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
has_alert_verdicts: [],
has_alert_credited: true,
effective_from: '<string>',
effective_through: '<string>',
expiration_from: '<string>',
expiration_through: '<string>',
valid_on: '<string>'
},
agreement_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
excluded_agreement_ids: []
},
mode: 'outstanding',
invoices: {type: 'all', excluded_invoice_ids: []},
issued_from: '2023-12-25',
issued_through: '2023-12-25'
},
fingerprint: '<string>'
})
};
fetch('https://api-canary.watchdog.no/v1/check-selections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-canary.watchdog.no/v1/check-selections"
payload = {
"selection": {
"scope": {
"type": "agreements",
"filter": {
"mine": True,
"team_ids": ["<string>"],
"ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"renewal_action_kinds": [],
"renewal_deadline_from": "<string>",
"renewal_deadline_through": "<string>",
"search": "<string>",
"statuses": [],
"supplier_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"recipient_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"tag_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"has_alert_verdicts": [],
"has_alert_credited": True,
"effective_from": "<string>",
"effective_through": "<string>",
"expiration_from": "<string>",
"expiration_through": "<string>",
"valid_on": "<string>"
},
"agreement_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"excluded_agreement_ids": []
},
"mode": "outstanding",
"invoices": {
"type": "all",
"excluded_invoice_ids": []
},
"issued_from": "2023-12-25",
"issued_through": "2023-12-25"
},
"fingerprint": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"agreements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"check_count": 123
}
],
"mode": "outstanding",
"workflow_run_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"invoice_count": 123,
"check_count": 123,
"deleted_alert_count": 123,
"kept_alert_count": 123,
"kept_user_alert_count": 123,
"cancelled_check_count": 123
}{
"agreements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"check_count": 123
}
],
"mode": "outstanding",
"workflow_run_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"invoice_count": 123,
"check_count": 123,
"deleted_alert_count": 123,
"kept_alert_count": 123,
"kept_user_alert_count": 123,
"cancelled_check_count": 123
}{
"error": {
"code": "validation_error",
"message": "The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB.",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "The bearer token is missing or invalid.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Stale preview, oversized selection, conflicting request key or no eligible work. Nothing new started.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Wait for the Retry-After delay before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Dispatch was not confirmed for every run. Read the receipt at Location; do not submit a fresh key.",
"request_id": "req_example"
}
}Authorizations
Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).
Headers
The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.
Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.
1 - 200^[\x21-\x7e]+$Body
Response
Reset completed or original receipt replayed.
Show child attributes
Show child attributes
outstanding, again, reset