Skip to navigation

Approval Integrations

View as Markdown

tool.approval.integrations

  • Endpoint: /tool/approval/integrations | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/approval/integrationsList approval integrations
POST/tool/approval/integrationsCreate approval integration
GET/tool/approval/integrations/{id}Get approval integration
PATCH/tool/approval/integrations/{id}Update approval integration

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of this configuration, assigned by the server.
connector_idstring✅The connector these approval settings apply to. Only one configuration can exist per connector, and it cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
default_resourceApprovalResourceSettingsDefault approval settings for all resource types from this connector. Resource-specific settings take precedence.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"connector_id": "<connector-uuid>",
"default_resource": {
"resource_type": "REQUEST_ITEM",
"buttons": [
{
"type": "approve",
"display_info": {}
}
],
"link_strategy": {
"template": {
"url_template": "https://example.com/path"
}
},
"mapper_bender": {},
"augmenter_bender": {},
"augmenting_data_retrievers": [
{
"ticket_approval_data_retriever": {}
}
],
"record_prefilter_dsl": "true",
"notification_filter_dsl": "true",
"external_resource_keys": [
"<string>"
]
},
"version": {
"change_description": "Create approval integration"
}
}