ServiceNow Get
CertifiedFetch records from a ServiceNow table
ServiceNow Get
Fetch records from a ServiceNow table
Reads rows from the specified table using Basic Auth or the OAuth password grant and returns the raw ServiceNow payload plus the count.
type: io.kestra.plugin.servicenow.GetExamples
Get incidents using BasicAuth.
id: servicenow_get
namespace: company.team
tasks:
- id: get
type: io.kestra.plugin.servicenow.Get
domain: "snow_domain"
username: "snow_username"
password: "{{ secret('SNOW_PASSWORD') }}"
table: incident
Get incidents using OAuth.
id: servicenow_get
namespace: company.team
tasks:
- id: get
type: io.kestra.plugin.servicenow.Get
domain: "snow_domain"
username: "snow_username"
password: "{{ secret('SNOW_PASSWORD') }}"
clientId: "{{ secret('SNOW_CLIENT_ID') }}"
clientSecret: "{{ secret('SNOW_CLIENT_SECRET') }}"
table: incident
Get high-priority active incidents with pagination.
id: servicenow_get_filtered
namespace: company.team
tasks:
- id: get
type: io.kestra.plugin.servicenow.Get
domain: "{{ secret('SNOW_DOMAIN') }}"
username: "{{ secret('SNOW_USERNAME') }}"
password: "{{ secret('SNOW_PASSWORD') }}"
table: incident
query: "active=true^priority=1"
fields:
- number
- short_description
- priority
- state
limit: 100
offset: 0
Stream incidents to internal storage as ION.
id: servicenow_get_store
namespace: company.team
tasks:
- id: get
type: io.kestra.plugin.servicenow.Get
domain: "{{ secret('SNOW_DOMAIN') }}"
username: "{{ secret('SNOW_USERNAME') }}"
password: "{{ secret('SNOW_PASSWORD') }}"
table: incident
fetchType: STORE
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-servicenow --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
password *string
ServiceNow password
Account password used with 'username' for Basic Auth or OAuth password grant
table *string
ServiceNow table
API name of the table to query (for example incident).
username *string
ServiceNow username
Used with 'password' for Basic Auth or with client credentials for the OAuth password grant
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150clientId string
ServiceNow OAuth client ID
Required with 'clientSecret' plus 'username' and 'password' to switch requests to OAuth bearer tokens
clientSecret string
ServiceNow OAuth client secret
Paired with 'clientId' when using the OAuth password grant
domain string
ServiceNow domain
Subdomain used to build https://<domain>.service-now.com/; do not include protocol. Required unless uri is set.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch type
Controls how results are returned: FETCH (default) returns all records in memory, FETCH_ONE returns only the first record, STORE writes all records as ION to internal storage and returns a URI.
fields array
Fields to return
Comma-joined list of field names sent as sysparm_fields. When absent, all fields are returned.
headers object
Additional request headers
Optional key/value headers rendered per execution and sent with every call
limit integerstring
Maximum records to return
Appended as sysparm_limit. When absent, ServiceNow applies its own default limit.
offset integerstring
Starting record index
Appended as sysparm_offset. Use together with limit for page-by-page retrieval.
options
HTTP client configuration
Advanced HTTP settings such as timeouts, proxies, and TLS; defaults to Kestra HTTP client values
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
query string
Encoded query filter
ServiceNow encoded query string appended as sysparm_query (for example active=true^priority=1).
uri string
ServiceNow base URI
Optional base URL override for custom or mock ServiceNow instances; defaults to https://<domain>.service-now.com/ when not set. Takes precedence over domain.
Outputs
offset integer
Offset used in the request
Value of sysparm_offset sent with this request. Null when no offset was specified. Add size to this value to get the offset for the next page.
results array
Result records
List of rows exactly as returned by ServiceNow. Null when fetchType is STORE.
size integer
Result size
Number of records returned or written.
uri string
uriStorage URI
URI of the ION file in internal storage. Set only when fetchType is STORE.
