Skip to navigation

Create webhook listener

View as Markdown

Creates a webhook listener and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this webhook listener refers to must already exist.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
display_namestringRequired3-64 characters
A readable name for the listener. 3 to 64 characters.
versionobjectRequired
Document version. On update, send back the num from your last read.
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 created webhook listener
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
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error