Skip to main content
POST
Update Webhook

Authorizations

X-API-KEY
string
header
required

Production API Key. You can find it under My API in the ADP platform. Make sure the API Key is active and belongs to the production environment.

Path Parameters

tenant_name
string
default:laiye
required

Tenant name. Default: laiye.

Body

application/json
webhook_id
string
required
Minimum string length: 1
webhook_url
string<uri>
required

New public HTTPS callback URL.

Maximum string length: 512
Pattern: ^https://
event_types
enum<string>[]
Minimum array length: 1
Available options:
doc_parse_completed,
doc_extract_completed,
collaboration_start,
collaboration_success,
collaboration_failed,
collaboration_completed,
collaboration_timeout
app_id
string[] | null

Passing null or an empty array explicitly clears the application scope; omitting it leaves the scope unchanged.

Minimum string length: 1

Response

Webhook creation or update result.

code

Business code. A successful response is usually success or 200.

message
string

Response message.

tips
string | null

Details. Defaults to null.

data
object | null