Skip to navigation

Update webhook listener

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, null clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, workflow_steps and resolver_methods are replaced whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the webhook listener, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
display_namestringOptional3-64 characters
A readable name for the listener. 3 to 64 characters.
signatureobjectOptional
The technical name and description that identify this listener.
reject_processing_dslstringOptional

Moveworks DSL rule that acts as a kill switch. When true, the request is not processed. Evaluated against request_body, headers and query_params. Must be a valid MWDSL expression.

log_redaction_enabledbooleanOptional
If true, possibly sensitive data is redacted from this listener's logs.
securityobjectOptional
How the listener endpoint is secured, such as Moveworks authentication and an IP allowlist.
verificationobjectOptional

Request-level checks, such as signature verification, run on each incoming request.

payloadobjectOptional
How the request payload is parsed, validated and mapped into an event.
debounceobjectOptional
Settings that collapse a burst of duplicate requests into a single event.
challengeobjectOptional

Settings for answering one-time verification (CRC) challenge requests from the external system.

Response

The updated webhook listener, at its new version
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
display_namestringOptional3-64 characters
A readable name for the listener. 3 to 64 characters.
url_uuidslist of stringsOptionalRead-only
Identifiers used to build the listener's public webhook URL. Generated by the server on create and cannot be changed.
signatureobjectOptional
The technical name and description that identify this listener.
reject_processing_dslstringOptional

Moveworks DSL rule that acts as a kill switch. When true, the request is not processed. Evaluated against request_body, headers and query_params.

log_redaction_enabledbooleanOptional
If true, possibly sensitive data is redacted from this listener's logs.
securityobjectOptional
How the listener endpoint is secured, such as Moveworks authentication and an IP allowlist.
verificationobjectOptional

Request-level checks, such as signature verification, run on each incoming request.

payloadobjectOptional
How the request payload is parsed, validated and mapped into an event.
debounceobjectOptional
Settings that collapse a burst of duplicate requests into a single event.
challengeobjectOptional

Settings for answering one-time verification (CRC) challenge requests from the external system.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error