ServiceNow Update
CertifiedUpdate a ServiceNow record by sys_id
ServiceNow Update
Update a ServiceNow record by sys_id
Issues a PUT to the table REST API to change fields on the specified record using Basic Auth or the OAuth password grant.
type: io.kestra.plugin.servicenow.UpdateExamples
Update a ServiceNow record
id: servicenow_update
namespace: company.team
tasks:
- id: update
type: io.kestra.plugin.servicenow.Update
domain: "snow_domain"
username: "snow_username"
password: "{{ secret('SNOW_PASSWORD') }}"
table: incident
sysId: "a7ec77cbdefac300d322d182689619dc"
data:
short_description: "Updated via Kestra"
Properties
data *Requiredobject
Fields to update
Key/value map rendered to JSON and sent in the PUT body.
domain *Requiredstring
ServiceNow domain
Subdomain used to build https://<domain>.service-now.com/; do not include protocol
password *Requiredstring
ServiceNow password
Account password used with 'username' for Basic Auth or OAuth password grant
sysId *Requiredstring
Record sys_id
Unique identifier of the record to update.
table *Requiredstring
ServiceNow table
API name of the table containing the record.
username *Requiredstring
ServiceNow username
Used with 'password' for Basic Auth or with client credentials for the OAuth password grant
clientId 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
headers object
Additional request headers
Optional key/value headers rendered per execution and sent with every call
options Non-dynamic
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.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
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.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
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.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
Outputs
result object
The updated record returned by ServiceNow
