Update a webhook by its ID
PUT/webhook/:webhookId
Update a webhook by its ID
Request
Path Parameters
The unique ID of the webhook to update.
- application/json
Body
Updated webhook data
The body template for the webhook request, supporting variables
Custom headers to include in the webhook request, such as authentication tokens
The URL to which the webhook will send event data
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Webhook successfully updated
- application/json
- Schema
- Example (from schema)
Schema
Custom headers to include in the webhook request, such as authentication tokens.
The body for the webhook request, supporting variables.
Unique identifier of the webhook
The URL to which the webhook will send event data.
Time representation of entity creation
Possible values: [submission_approved
]
Event type that triggers the webhook.
Possible values: [schema
]
Resource to attach the webhook to
Unique identifier of the project to which webhook is related
Identifier of the resource to attach webhook to
{
"headers": "{\"Bearer\": \"$bearertoken\", \"customHeader\": \"$customHeader\"}",
"body": "{\"userId\": \"$userId\", \"resource\": \"$resource\", \"resourceId\": \"$resourceId\"}",
"id": "a1fb86bad-de7c-4ed7-a1c6-538db2b0c9ed",
"url": "https://example.com/webhook/$userId",
"createdAt": "2024-01-01T09:00:00.00Z",
"eventType": "submission_approved",
"resource": "schema",
"projectId": "p2Duhf5N6",
"resourceId": "s12RHo2ET"
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Unauthorized access"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Forbidden access"
}
Webhook not found
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
{
"error": "string"
}
{
"error": "Internal Server Error"
}