NRCS connections
Connect your newsroom systems, manage the webhook that delivers their stories, switch story checks on or off, and list where a story can be pushed.
x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
include?stringSet to health to include each connection's outbound credential health. Omitted entirely by default, so the ordinary list pays no health-lookup cost.
Every NRCS connection configured for the organization. Items carry health only when the request includes ?include=health.
application/json- response
items*array<>curl -X GET 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs'{ "items": [ { "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } }, "health": { "status": "healthy", "lastError": "string", "lastCheckedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "fundingStatus": "ok" } } ]}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
application/json- body
Saga NRCS connection
displayName*stringNRCS connection display name
1 <= lengthvendor*"saga""saga"baseUrl*stringSaga's API host (https only)
uriinstanceUrl*stringThe org's hosted Saga instance (https only)
uriapiKey*string1 <= lengthNRCS connection created
application/json- response
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$displayName*stringNRCS connection display name
1 <= lengthcredentialId*stringReference to stored credential
skillsEnabled?booleanWhether this connection's stories are processed by the org's skills at all. Absent (rows predating this field) means disabled.
falseskillsEnabledAt?stringWhen skillsEnabled was last switched on; workers only process stories received at or after this moment
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timeversion*integerMonotonic row version; used as concurrency token
vendor*"saga""saga"baseUrl*stringSaga's API host (https only)
uriinstanceUrl*stringThe org's hosted Saga instance (https only)
uriwebhookEnabled?booleanWhether an inbound Saga webhook is enabled for this connection
webhookToken?stringURL token identifying this connection's webhook endpoint
webhookCredentialId?stringReference to the stored credential holding the webhook verification secret
pitchFeed?Per-connection pitch feed delivery config; absent on rows that predate it
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs' \ -H 'Content-Type: application/json' \ -d '{ "displayName": "string", "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "apiKey": "string"}'{ "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } }}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$include?stringSet to health to include the connection's outbound credential health. Omitted entirely by default.
The NRCS connection. Carries health only when the request includes ?include=health.
application/json- response
health?Health of a credential from the most recent harvest auth check, null when never checked
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$displayName*stringNRCS connection display name
1 <= lengthcredentialId*stringReference to stored credential
skillsEnabled?booleanWhether this connection's stories are processed by the org's skills at all. Absent (rows predating this field) means disabled.
falseskillsEnabledAt?stringWhen skillsEnabled was last switched on; workers only process stories received at or after this moment
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timeversion*integerMonotonic row version; used as concurrency token
vendor*"saga""saga"baseUrl*stringSaga's API host (https only)
uriinstanceUrl*stringThe org's hosted Saga instance (https only)
uriwebhookEnabled?booleanWhether an inbound Saga webhook is enabled for this connection
webhookToken?stringURL token identifying this connection's webhook endpoint
webhookCredentialId?stringReference to the stored credential holding the webhook verification secret
pitchFeed?Per-connection pitch feed delivery config; absent on rows that predate it
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string'{ "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } }, "health": { "status": "healthy", "lastError": "string", "lastCheckedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "fundingStatus": "ok" }}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$application/json- body
displayName?string1 <= lengthbaseUrl?stringuriinstanceUrl?stringuriapiKey?string1 <= lengthpitchFeed?NRCS connection updated
application/json- response
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$displayName*stringNRCS connection display name
1 <= lengthcredentialId*stringReference to stored credential
skillsEnabled?booleanWhether this connection's stories are processed by the org's skills at all. Absent (rows predating this field) means disabled.
falseskillsEnabledAt?stringWhen skillsEnabled was last switched on; workers only process stories received at or after this moment
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timeversion*integerMonotonic row version; used as concurrency token
vendor*"saga""saga"baseUrl*stringSaga's API host (https only)
uriinstanceUrl*stringThe org's hosted Saga instance (https only)
uriwebhookEnabled?booleanWhether an inbound Saga webhook is enabled for this connection
webhookToken?stringURL token identifying this connection's webhook endpoint
webhookCredentialId?stringReference to the stored credential holding the webhook verification secret
pitchFeed?Per-connection pitch feed delivery config; absent on rows that predate it
curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } }}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$NRCS connection deleted, together with its credential
curl -X DELETE 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string'x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Webhook enabled for this NRCS connection
application/json- response
config*webhookSecret?stringCleartext webhook verification secret; present only when a fresh one was minted (first enable, or replacing a missing one)
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string/webhook/enable'{ "config": { "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } } }, "webhookSecret": "string"}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Webhook URL token and verification secret rotated
application/json- response
config*webhookSecret*stringFreshly rotated cleartext webhook verification secret
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string/webhook/regenerate'{ "config": { "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } } }, "webhookSecret": "string"}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$Webhook disabled for this NRCS connection
application/json- response
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$displayName*stringNRCS connection display name
1 <= lengthcredentialId*stringReference to stored credential
skillsEnabled?booleanWhether this connection's stories are processed by the org's skills at all. Absent (rows predating this field) means disabled.
falseskillsEnabledAt?stringWhen skillsEnabled was last switched on; workers only process stories received at or after this moment
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timeversion*integerMonotonic row version; used as concurrency token
vendor*"saga""saga"baseUrl*stringSaga's API host (https only)
uriinstanceUrl*stringThe org's hosted Saga instance (https only)
uriwebhookEnabled?booleanWhether an inbound Saga webhook is enabled for this connection
webhookToken?stringURL token identifying this connection's webhook endpoint
webhookCredentialId?stringReference to the stored credential holding the webhook verification secret
pitchFeed?Per-connection pitch feed delivery config; absent on rows that predate it
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string/webhook/disable'{ "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } }}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$application/json- body
skillsEnabled*booleanThe connection's skills switch was updated
application/json- response
id*stringNRCS connection identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$orgId*stringOwning organization identifier
^[0-7][0-9A-HJKMNP-TV-Z]{25}$displayName*stringNRCS connection display name
1 <= lengthcredentialId*stringReference to stored credential
skillsEnabled?booleanWhether this connection's stories are processed by the org's skills at all. Absent (rows predating this field) means disabled.
falseskillsEnabledAt?stringWhen skillsEnabled was last switched on; workers only process stories received at or after this moment
date-timecreatedAt*stringISO 8601 creation timestamp
date-timeupdatedAt*stringISO 8601 last-modified timestamp
date-timeversion*integerMonotonic row version; used as concurrency token
vendor*"saga""saga"baseUrl*stringSaga's API host (https only)
uriinstanceUrl*stringThe org's hosted Saga instance (https only)
uriwebhookEnabled?booleanWhether an inbound Saga webhook is enabled for this connection
webhookToken?stringURL token identifying this connection's webhook endpoint
webhookCredentialId?stringReference to the stored credential holding the webhook verification secret
pitchFeed?Per-connection pitch feed delivery config; absent on rows that predate it
curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/nrcs-configs/string/skills' \ -H 'Content-Type: application/json' \ -d '{ "skillsEnabled": true}'{ "id": "string", "orgId": "string", "displayName": "string", "credentialId": "string", "skillsEnabled": false, "skillsEnabledAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "vendor": "saga", "baseUrl": "http://example.com", "instanceUrl": "http://example.com", "webhookEnabled": true, "webhookToken": "string", "webhookCredentialId": "string", "pitchFeed": { "enabled": false, "desks": { "property1": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" }, "property2": { "provider": "string", "enabledAt": "2019-08-24T14:15:22Z" } } }}x-api-key<token>A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.
Every NRCS connection of the organization, as a push target.
application/json- response
items*array<>curl -X GET 'https://api.nuvelics.com/api/tenant/v1/nrcs-push-targets'{ "items": [ { "id": "string", "displayName": "string", "vendor": "saga", "instanceUrl": "string" } ]}