Retrieve a webhook by its ID
GET/webhook/:webhookId
Retrieve a webhook by its ID
Request
Path Parameters
webhookId stringrequired
The unique ID of the webhook to retrieve.
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Webhook retrieved successfully
- application/json
- Schema
- Example (from schema)
Schema
headers string
Custom headers to include in the webhook request, such as authentication tokens.
body string
The body for the webhook request, supporting variables.
id string
Unique identifier of the webhook
url urirequired
The URL to which the webhook will send event data.
createdAt date-time
Time representation of entity creation
eventType stringrequired
Possible values: [submission_approved
]
Event type that triggers the webhook.
resource stringrequired
Possible values: [schema
]
Resource to attach the webhook to
projectId string
Unique identifier of the project to which webhook is related
resourceId stringrequired
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": "string"
}
{
"error": "Bad Request"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Unauthorized access"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Forbidden access"
}
NotFound
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "A mandatory item was not found"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Internal Server Error"
}
Loading...