Skip to navigation

Get webhook listener

View as Markdown

Returns one webhook listener by its id. Secrets come back redacted.

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.

Response

The 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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error