Contact Us 1-800-596-4880

Spiff Connector 1.0 Reference

Configurations


Config

Default configuration for Spiff Connector. Configure the HMAC-signed webhook connection, HTTP client settings, and request defaults.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Response Timeout

Number

Maximum time to wait for a Spiff response. Operations can override it.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This doesn’t mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

HMAC Signed Webhook Connection

Signs each request with the configured webhook secret and sends it to the Spiff Webhook API.

Parameters
Name Type Description Default Value Required

Subdomain

String

Spiff environment subdomain (for example us1 resolves to https://us1.spiff.com). A full base URL such as https://host.example.com is also accepted for non-production environments.

x

Connector ID

String

Raw integer ID of the Spiff webhook connector (Spiff Admin > Connectors). The base64 Relay ID isn’t accepted.

x

Webhook Secret

String

Spiff webhook secret used as the HMAC-SHA256 signing key. It is never sent on the wire or logged.

x

Company UUID

String

Spiff company UUID (Spiff Admin > Settings > Company Settings), sent as company_uuid on every signed mutation.

x

Connection Timeout

Number

Time to wait for a TCP connection to be established. Also used as the response timeout of Test Connection.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Whether to reuse TCP connections across requests.

true

Max Connections

Number

Maximum simultaneous outbound connections. -1 means unlimited.

-1

Connection Idle Timeout

Number

Time a connection can stay idle before closing. Applies only when persistent connections are enabled.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Stream Response

Boolean

When enabled, allows processing to begin after headers are parsed. The response must be read eventually to avoid memory issues.

false

Response Buffer Size

Number

Space in bytes for the buffer where the HTTP response is stored.

-1

Proxy Configuration

One of:

Outbound HTTP proxy used to reach Spiff.

TLS Configuration

Tls

TLS configuration to use when connecting to Spiff over HTTPS.

Default Headers

Array of Default Header

Custom headers to include in every request.

Default Query Parameters

Custom query parameters to include in every request.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Operations

Delete Multiple Records

<spiff:delete-multiple-records>

Deletes multiple records from the specified Spiff mapping. Provide an array of record identity objects.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Mapping ID

String

Spiff mapping that holds the records to delete.

x

Record Identities

Any

JSON array of identity objects for the records to delete.

#[payload]

Response Timeout

Number

Maximum time to wait for the Spiff response. Defaults to the configuration value.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Additional query parameters sent with this request only.

Custom Headers

Object

Additional headers sent with this request only.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Associated Configurations

Throws

  • SPIFF:BAD_GATEWAY

  • SPIFF:BAD_REQUEST

  • SPIFF:CLIENT_ERROR

  • SPIFF:CONNECTIVITY

  • SPIFF:FORBIDDEN

  • SPIFF:GATEWAY_TIMEOUT

  • SPIFF:INVALID_INPUT

  • SPIFF:NOT_FOUND

  • SPIFF:PAYLOAD_TOO_LARGE

  • SPIFF:RATE_LIMITED

  • SPIFF:RETRY_EXHAUSTED

  • SPIFF:SERVER_ERROR

  • SPIFF:SERVICE_ERROR

  • SPIFF:SERVICE_UNAVAILABLE

  • SPIFF:TIMEOUT

  • SPIFF:UNAUTHORIZED

  • SPIFF:UNPROCESSABLE_ENTITY

Delete Single Record

<spiff:delete-single-record>

Deletes one record from the specified Spiff mapping. Provide the identity field or fields for the record.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Mapping ID

String

Spiff mapping that holds the record to delete.

x

Record Identity

Any

JSON object with the identity field or fields of the record to delete.

#[payload]

Response Timeout

Number

Maximum time to wait for the Spiff response. Defaults to the configuration value.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Additional query parameters sent with this request only.

Custom Headers

Object

Additional headers sent with this request only.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Associated Configurations

Throws

  • SPIFF:BAD_GATEWAY

  • SPIFF:BAD_REQUEST

  • SPIFF:CLIENT_ERROR

  • SPIFF:CONNECTIVITY

  • SPIFF:FORBIDDEN

  • SPIFF:GATEWAY_TIMEOUT

  • SPIFF:INVALID_INPUT

  • SPIFF:NOT_FOUND

  • SPIFF:PAYLOAD_TOO_LARGE

  • SPIFF:RATE_LIMITED

  • SPIFF:RETRY_EXHAUSTED

  • SPIFF:SERVER_ERROR

  • SPIFF:SERVICE_ERROR

  • SPIFF:SERVICE_UNAVAILABLE

  • SPIFF:TIMEOUT

  • SPIFF:UNAUTHORIZED

  • SPIFF:UNPROCESSABLE_ENTITY

Put Multiple Records

<spiff:put-multiple-records>

Creates or updates multiple records in the specified Spiff mapping.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Mapping ID

String

Spiff mapping that receives the records.

x

Records

Any

JSON array of record objects.

#[payload]

Response Timeout

Number

Maximum time to wait for the Spiff response. Defaults to the configuration value.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Additional query parameters sent with this request only.

Custom Headers

Object

Additional headers sent with this request only.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Associated Configurations

Throws

  • SPIFF:BAD_GATEWAY

  • SPIFF:BAD_REQUEST

  • SPIFF:CLIENT_ERROR

  • SPIFF:CONNECTIVITY

  • SPIFF:FORBIDDEN

  • SPIFF:GATEWAY_TIMEOUT

  • SPIFF:INVALID_INPUT

  • SPIFF:NOT_FOUND

  • SPIFF:PAYLOAD_TOO_LARGE

  • SPIFF:RATE_LIMITED

  • SPIFF:RETRY_EXHAUSTED

  • SPIFF:SERVER_ERROR

  • SPIFF:SERVICE_ERROR

  • SPIFF:SERVICE_UNAVAILABLE

  • SPIFF:TIMEOUT

  • SPIFF:UNAUTHORIZED

  • SPIFF:UNPROCESSABLE_ENTITY

Put Single Record

<spiff:put-single-record>

Creates or updates one record in the specified Spiff mapping.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Mapping ID

String

Spiff mapping that receives the record.

x

Record

Any

JSON object with the record’s translator-field values.

#[payload]

Response Timeout

Number

Maximum time to wait for the Spiff response. Defaults to the configuration value.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Additional query parameters sent with this request only.

Custom Headers

Object

Additional headers sent with this request only.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Associated Configurations

Throws

  • SPIFF:BAD_GATEWAY

  • SPIFF:BAD_REQUEST

  • SPIFF:CLIENT_ERROR

  • SPIFF:CONNECTIVITY

  • SPIFF:FORBIDDEN

  • SPIFF:GATEWAY_TIMEOUT

  • SPIFF:INVALID_INPUT

  • SPIFF:NOT_FOUND

  • SPIFF:PAYLOAD_TOO_LARGE

  • SPIFF:RATE_LIMITED

  • SPIFF:RETRY_EXHAUSTED

  • SPIFF:SERVER_ERROR

  • SPIFF:SERVICE_ERROR

  • SPIFF:SERVICE_UNAVAILABLE

  • SPIFF:TIMEOUT

  • SPIFF:UNAUTHORIZED

  • SPIFF:UNPROCESSABLE_ENTITY

Test Webhook

<spiff:test-webhook>

Verifies that Spiff accepts the configured connection signature without storing the test record.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Test Record

Any

Sample JSON object to sign and send. Spiff doesn’t upsert it.

#[payload]

Response Timeout

Number

Maximum time to wait for the Spiff response. Defaults to the configuration value.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Output Mime Type

String

The MIME type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Additional query parameters sent with this request only.

Custom Headers

Object

Additional headers sent with this request only.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Associated Configurations

Throws

  • SPIFF:BAD_GATEWAY

  • SPIFF:BAD_REQUEST

  • SPIFF:CLIENT_ERROR

  • SPIFF:CONNECTIVITY

  • SPIFF:FORBIDDEN

  • SPIFF:GATEWAY_TIMEOUT

  • SPIFF:INVALID_INPUT

  • SPIFF:NOT_FOUND

  • SPIFF:PAYLOAD_TOO_LARGE

  • SPIFF:RATE_LIMITED

  • SPIFF:RETRY_EXHAUSTED

  • SPIFF:SERVER_ERROR

  • SPIFF:SERVICE_ERROR

  • SPIFF:SERVICE_UNAVAILABLE

  • SPIFF:TIMEOUT

  • SPIFF:UNAUTHORIZED

  • SPIFF:UNPROCESSABLE_ENTITY

Types

Tls

Configures TLS for secure communications with Spiff.

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust store that contains certificates used to validate the Spiff server certificate.

Key Store

Key store that contains the client certificate and private key when Spiff requires mutual TLS.

Revocation Check

Certificate revocation-check configuration.

Trust Store

Configures the trust store that validates Spiff server certificates.

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Configures the key store that supplies a client certificate and private key for mutual TLS.

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Configures standard certificate revocation checks.

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can’t be reached or is busy.

Custom Ocsp Responder

Configures a custom OCSP responder for certificate revocation checks.

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Specifies the location of a certificate revocation list file.

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Default Header

Defines an HTTP header that the connector includes with every request.

Field Type Description Default Value Required

Key

String

HTTP header name.

x

Value

String

HTTP header value.

x

Default Query Param

Defines a query parameter that the connector includes with every request.

Field Type Description Default Value Required

Key

String

Query parameter name.

x

Value

String

Query parameter value.

x

Reconnection

Configures a reconnection strategy for connection failures.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Configures a reconnection strategy with a maximum number of attempts.

Field Type Description Default Value Required

Frequency

Number

How often to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Configures a reconnection strategy that continues until the Mule app stops.

Field Type Description Default Value Required

Frequency

Number

How often to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures the expiration policy for dynamic configuration instances.

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance can remain idle before it is eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Http Response Attributes

Provides the HTTP response attributes returned by Spiff operations.

Field Type Description Default Value Required

Headers

Object

Response headers returned by Spiff.

Reason Phrase

String

HTTP reason phrase returned by Spiff.

Status Code

Number

HTTP status code returned by Spiff.

Repeatable In Memory Stream

Configures an in-memory repeatable streaming strategy.

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer shouldn’t expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

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 Max Buffer Size fields.

Repeatable File Store Stream

Configures a repeatable file-store streaming strategy.

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Error Mapping

Maps a source Mule error type to a target error type.

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source Mule error type to map.

Target

String

Target error type that replaces the source error type.

x

Default

Configures a standard outbound HTTP proxy.

Field Type Description Default Value Required

Host

String

Proxy host name.

x

Port

Number

Proxy port.

x

Username

String

User name for proxy authentication.

Password

String

Password for proxy authentication.

Non Proxy Hosts

String

Comma-separated host patterns that bypass the proxy.

NTLM

Configures an NTLM-authenticated outbound HTTP proxy.

Field Type Description Default Value Required

Ntlm Domain

String

NTLM domain for proxy authentication.

x

Host

String

Proxy host name.

x

Port

Number

Proxy port.

x

Username

String

User name for proxy authentication.

Password

String

Password for proxy authentication.

Non Proxy Hosts

String

Comma-separated host patterns that bypass the proxy.