--- schema_version: "1" id: c5a1db763faeac09ea662b038bc28d04d5d1729bba1e69a1ae383610360a53a0 title: ServiceNow Connector 6.18 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/servicenow-connector/latest/servicenow-reference.md canonical_url: https://docs.mulesoft.com/servicenow-connector/latest/servicenow-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 11d839a8b8c0206b43e158fd8def744685d3bcf5b5bea7d2633f07425ed91e2d description: MuleSoft Documentation Site release: "6.18" latest: true --- --- product: ServiceNow Connector version: 6.18 is-latest-version: true --- # ServiceNow Connector 6.18 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for ServiceNow (ServiceNow Connector) provides connections between Mule runtime engine (Mule) and ServiceNow apps. ## Configuration Default Configuration for ServiceNow Connector.

Name	Type	Description	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.	x
Connection	Basic Authentication OAuth 2.0 Authorization Code	Connection types for this configuration.	x
Name	String	ID used to reference this configuration.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

### Basic Authentication Connection Type

Name	Type	Description	Default Value	Required
Service Address	String	Address of the ServiceNow service.		x
ServiceNow Version	Enumeration, one of: EUREKA FUJI GENEVA HELSINKI ISTANBUL JAKARTA KINGSTON MADRID NEW_YORK ORLANDO PARIS QUEBEC ROME SAN_DIEGO TOKYO UTAH VANCOUVER WASHINGTON XANADU YOKOHAMA ZURICH AUSTRALIA	ServiceNow API Version.	`WASHINGTON`
User Tables List	Array of String	List of user-defined tables.
Encoding	String	Character encoding.	`UTF-8`
User Name	String	Username.		x
Password	String	Password.		x
Transport Configuration	One of: HTTP Requester Based Transport Provider Basic Authentication HTTP Message Dispatcher Provider	Transport configuration.
Sign Security Strategy	Wss Sign Security Strategy Adapter	WSS configuration for the signature security strategy.
Username Token Security Strategy	WSS Username Token Security Strategy Adapter	WSS configuration for the username token security strategy.
Reconnection	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
Pooling Profile	Pooling Profile	Characteristics of the connection pool.

### OAuth 2.0 Authorization Code Connection Type Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

Name	Type	Description	Default Value	Required
Service Address	String	Address of ServiceNow service.		x
ServiceNow Version	Enumeration, one of: EUREKA FUJI GENEVA HELSINKI ISTANBUL JAKARTA KINGSTON MADRID NEW_YORK ORLANDO PARIS QUEBEC ROME SAN_DIEGO TOKYO UTAH VANCOUVER WASHINGTON XANADU YOKOHAMA ZURICH AUSTRALIA	ServiceNow API Version.	`WASHINGTON`
User Tables List	Array of String	List of user-defined tables.
Encoding	String	Character encoding.	`UTF-8`
Custom Transport Configuration	OAuth2 HTTP Message Dispatcher Provider	Custom transport configuration.
State	String	String value that you send when the OAuth dance is initiated and that is returned back by the service provider with the token callback.
Sign Security Strategy	Wss Sign Security Strategy Adapter	WSS configuration for the signature security strategy.
Username Token Security Strategy	WSS Username Token Security Strategy Adapter	Username token WSS configuration.
Reconnection	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
Consumer Key	String	OAuth consumer key, as registered with the service provider.		x
Consumer Secret	String	OAuth consumer secret, as registered with the service provider.		x
Authorization Url	String	URL of the service provider’s authorization endpoint.	`https://{instance-id}.service-now.com/oauth_auth.do`
Access Token Url	String	URL of the service provider’s access token endpoint.	`https://{instance-id}.service-now.com/oauth_token.do`
Scopes	String	OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.
Resource Owner Id	String	Resource owner ID to use with the authorization code grant type.
Before	String	Name of the flow to execute immediately before starting the OAuth dance.
After	String	Name of the flow to execute immediately after receiving an access token.
Listener Config	String	Configuration for the HTTP listener that listens for requests on the access token callback endpoint.		x
Callback Path	String	Path of the access token callback endpoint.		x
Authorize Path	String	Path of the local HTTP endpoint that triggers the OAuth dance.		x
External Callback Url	String	URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.
Object Store	String	Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

## Sources - [New / Updated Record](#new-or-updated-record-listener) > [!NOTE] To view custom or extended parent tables in ServiceNow Connector, select the **Allow > access to this table via web services** and **Allow configuration** options in the table > definition. ### New / Updated Record `` Efficiently polls periodically for changes in the selected table and accepts only new records into the flow.

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
ServiceNow Time Zone	String	Timezone.	`America/Los_Angeles`
Table name	String	Name of the table from which to retrieve the records.		x
Query	String	Optional query that filters the result set. The syntax is `sysparm_query=`. All parameters are case-sensitive. Queries can contain more than one entry, such as `[]`.
Display System References	String	Data retrieval operation for reference and choice fields. Retrieves the display value or the actual value from the database. Valid values are: `true` Returns the display values for all fields. `false` Returns the actual values from the database. `all` Returns both the actual and display values.	`FALSE`
Exclude Reference Links	Boolean	Flag that indicates whether to exclude table API links for reference fields.	`false`
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Primary Node Only	Boolean	Determines whether to execute this source on only the primary node when running Mule instances in a cluster.
Scheduling Strategy	Scheduling Strategy	Configures the scheduler that triggers the polling.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream Non-repeatable Stream	Configures how Mule processes streams. The default is to use repeatable streams.
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message.
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	SOAP Attributes

#### Associated Configurations - [Configuration](#config) ## Operations - [Invoke](#invoke) - [Unauthorize](#unauthorize) > [!NOTE] To view custom or extended parent tables in ServiceNow Connector, select the **Allow > access to this table via web services** and **Allow configuration** options in the table > definition. ### Invoke `` Default operation for ServiceNow SOAP invocations.

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Allow Empty Value	Boolean	Option that enables users to clear a specific field with a null or empty value for the `update` operation.	`false`
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.		x
Service	String	Service name.		x
Operation	String	Operation name of the service.		x
Show Reference Values	String	Chooses which values are returned for reference fields. Possible options are to return `sys_ids` or `display value` or both. Use this option only for `get` and `getRecords` operations.
Body	Binary	XML body to include in the SOAP message, with all the required parameters, or `null` if no parameters are required.	`#[payload]`
Headers	Binary	XML headers to include in the SOAP message.
Attachments	Object	Attachments to include in the SOAP request.
Target Variable	String	Name of the variable that stores the operation’s output.
Target Value	String	Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	SOAP Output Envelope
Attributes Type	SOAP Attributes

#### Associated Configurations - [Configuration](#config) #### Throws - SERVICENOW:RETRY\_EXHAUSTED - SERVICENOW:SOAP\_FAULT - SERVICENOW:PROCESSING\_ERROR - SERVICENOW:BAD\_RESPONSE - SERVICENOW:TIMEOUT - SERVICENOW:CONNECTIVITY - SERVICENOW:BAD\_REQUEST - SERVICENOW:CANNOT\_DISPATCH - SERVICENOW:INVALID\_WSDL - SERVICENOW:ENCODING ### Unauthorize `` Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without repeating the OAuth dance.

Name	Type	Description	Required
Configuration	String	Name of the configuration to use.	x
Resource Owner Id	String	ID of the resource owner for whom to invalidate access.
Config Ref	ConfigurationProvider	Name of the configuration to use to execute this component.	x

#### Associated Configurations - [Configuration](#config) ## Object Types - [Basic Authentication HTTP Message Dispatcher Provider](#basic-auth-http-message-dispatcher-provider) - [Expiration Policy](#ExpirationPolicy) - [HTTP Requester Based Transport Provider](#http-requester-based-transport-provider) - [OAuth2 HTTP Message Dispatcher Provider](#oauth2-http-message-dispatcher-provider) - [Pooling Profile](#PoolingProfile) - [Reconnect](#reconnect) - [Reconnect Forever](#reconnect-forever) - [Reconnection](#Reconnection) - [Redelivery Policy](#RedeliveryPolicy) - [Redelivery Policy Message Identifier](#RedeliveryPolicyMessageIdentifier) - [Repeatable File Store Stream](#repeatable-file-store-stream) - [Repeatable In Memory Stream](#repeatable-in-memory-stream) - [SOAP Attributes](#SoapAttributes) - [SOAP Output Envelope](#SoapOutputEnvelope) - [Wss Key Store Configuration](#wss-key-store-configuration) - [Wss Sign Security Strategy Adapter](#WssSignSecurityStrategyAdapter) - [WSS Signing Configuration Adapter](#WssSignConfigurationAdapter) - [WSS Username Token Security Strategy Adapter](#WssUsernameTokenSecurityStrategyAdapter) ### Basic Authentication HTTP Message Dispatcher Provider Default HTTP transport configuration.

Field	Type	Description	Default Value	Required
Username	String	Username to use.		x
Password	String	Password to use.		x
Read Timeout	Number	Read timeout value.	`15000`
Read Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Read Timeout field.	`MILLISECONDS`

### Expiration Policy Configures an expiration policy strategy.

Field	Type	Description	Default Value	Required
Max Idle Time	Number	Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

### HTTP Requester Based Transport Provider Custom HTTP transport configuration.

Field	Type	Description	Default Value	Required
Requester Config	String	Requester configuration.		x

### OAuth2 HTTP Message Dispatcher Provider OAuth transport configuration.

Field	Type	Description	Default Value	Required
Read Timeout	Number	Read timeout value.	`15000`
Read Timeout Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Read Timeout field.	`MILLISECONDS`

### Pooling Profile Pooling profile type.

Field	Type	Description
Max Active	Number	Controls the maximum number of Mule components that is borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that is active at one time. When the specified value for Max Active is exceeded, the pool is considered exhausted.
Max Idle	Number	Controls the maximum number of Mule components that sits idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that is idle at one time.
Max Wait	Number	Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the Exhausted Action is set to `WHEN_EXHAUSTED_WAIT`.
Min Eviction Millis	Number	Determines the minimum amount of time an object sits idle in the pool before it is eligible for eviction. When non-positive, no objects are evicted from the pool due to idle time alone.
Eviction Check Interval Millis	Number	Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.
Exhausted Action	Enumeration, one of: WHEN_EXHAUSTED_GROW WHEN_EXHAUSTED_WAIT WHEN_EXHAUSTED_FAIL	Specifies the behavior of the Mule component pool when the pool is exhausted: `WHEN_EXHAUSTED_GROW` Creates a new Mule instance and returns it, which makes Max Active ineffective. `WHEN_EXHAUSTED_WAIT` Blocks by invoking `Object.wait(long)` until a new or idle object is available. `WHEN_EXHAUSTED_FAIL` Throws a `NoSuchElementException`. If a positive Max Wait value is supplied, it blocks for, at most, that many milliseconds, after which a `NoSuchElementException` is thrown. If Max Thread Wait is a negative value, it blocks indefinitely.
Initialisation Policy	Enumeration, one of: INITIALISE_NONE INITIALISE_ONE INITIALISE_ALL	Determines how to initialize components in a pool: `INITIALISE_NONE` Does not load any components into the pool on startup. `INITIALISE_ONE` Loads one initial component into the pool on startup. `INITIALISE_ALL` Loads all components in the pool on startup.
Disabled	Boolean	Determines whether to disable pooling.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field	Type	Description
Frequency	Number	How often to attempt to reconnect, in milliseconds.
Blocking	Boolean	If `false`, the reconnection strategy runs in a separate, non-blocking thread.
Count	Number	How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field	Type	Description	Default Value	Required
Frequency	Number	How often to attempt to reconnect, in milliseconds.
Blocking	Boolean	If `false`, the reconnection strategy runs in a separate, non-blocking thread.

### Reconnection Configures a reconnection strategy for an operation.

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy: `true` Allow the deployment to fail. `false` Ignore the results of the connectivity test.
Reconnection Strategy	Reconnect Reconnect Forever	Reconnection strategy to use.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field	Type	Description
Max Redelivery Count	Number	Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.
Message Digest Algorithm	String	Secure hashing algorithm to use if the Use Secure Hash field is `true`. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s `hashCode()` returned.
Message Identifier	Redelivery Policy Message Identifier	One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is `false`.
Object Store	ObjectStore	Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field	Type	Description	Default Value	Required
Use Secure Hash	Boolean	If `true`, Mule uses a secure hash algorithm to identify a redelivered message.
Id Expression	String	One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is `false`.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field	Type	Description	Default Value	Required
In Memory Size	Number	Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance: Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory. Configure a smaller buffer size to decrease memory load at the expense of response time.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the In Memory Size field.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field	Type	Description
Initial Buffer Size	Number	Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.
Buffer Size Increment	Number	Amount by which the buffer size expands if it exceeds its initial size. Setting a value of `0` or lower specifies that the buffer can’t expand.
Max Buffer Size	Number	The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### SOAP Attributes Attributes returned by the consume operation. Carries the protocol specific headers (such as HTTP headers) and additional transport data (such as the HTTP status line) bounded to the response.

Field	Type	Description	Default Value	Required
Additional Transport Data	Object	Additional transport data bundled in the response.
Protocol Headers	Object	Protocol headers bundled in the response.

### SOAP Output Envelope Represents the response of the consume operation. Bundles the SOAP body, SOAP headers, and MIME attachments if there are any.

Field	Type	Description
Attachments	Object	Set of attachments bounded to the response, or an empty map if there are no attachments.
Body	Binary	XML response body. Represents the <SOAP:BODY> element.
Headers	Object	Set of XML SOAP headers. Represents the content in the <SOAP:HEADERS> element.

### Wss Key Store Configuration Implementation for keystores, used for encryption, decryption, and signing.

Field	Type	Description	Default Value	Required
Key Store Path	String	Location of the keystore file.		x
Alias	String	Alias of the private key to use.
Password	String	Password to access the store.		x
Key Password	String	Password used to access the private key.
Type	String	Type of store, such as `fjks`, `pkcs12`, `jceks`, and so on.	`jks`

### Wss Sign Security Strategy Adapter Signs the SOAP request that is sent, using the private key of the keystore in the provided TLS context.

Field	Type	Description	Default Value	Required
Key Store Configuration	Wss Key Store Configuration	Keystore to use when signing the message.		x
Sign Algorithm Configuration	WSS Signing Configuration Adapter	Algorithms to use on the signing.

### WSS Signing Configuration Adapter Group that holds the configuration for signing algorithms used in the sign security strategy.

Field	Type	Description	Default Value
Signature Key Identifier	Enumeration, one of: DIRECT_REFERENCE X509_KEY_IDENTIFIER	Key identifier type to use for the signature.	`X509_KEY_IDENTIFIER`
Signature Algorithm	Enumeration, one of: RSAwithSHA1 RSAwithSHA224 RSAwithSHA256 RSAwithSHA384 RSAwithSHA512	Signature algorithm to use. The default is set by the data in the certificate.
Signature Digest Algorithm	Enumeration, one of: SHA1 SHA256 SHA224 SHA384 SHA512	Signature digest algorithm to use.	`SHA1`
Signature C14n Algorithm	Enumeration, one of: CanonicalXML_1_0 CanonicalXML_1_1 ExclusiveXMLCanonicalization_1_0	Defines which signature c14n (canonicalization) algorithm to use.	`ExclusiveXMLCanonicalization_1_0`

### WSS Username Token Security Strategy Adapter Provides the capability to authenticate with a SOAP service using a username and a password by adding the UsernameToken element in the SOAP request.

Field	Type	Description	Default Value	Required
Username	String	Username required to authenticate with the service.		x
Password	String	Password for the provided username required to authenticate with the service.		x
Password Type	Enumeration, one of: DIGEST TEXT	Password parameter.	`DIGEST`

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)