Verify Endpoint
POST /v1/webhooks/endpoints/{endpoint_id}/verify
Prove you control the endpoint URL. InstaVM POSTs a signed
webhook.endpoint.challenge event carrying a challenge token; your server must
answer with a 2xx whose body is that token, either as JSON with a challenge field
or as plain text. On success the endpoint becomes active and starts receiving
events. A failed check still returns 200, with verified false and the reason in
error.
Authentication
Requires authentication via: OAuth2PasswordBearer.
Parameters
| Name | In | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
endpoint_id | path | string | Yes | ||
X-API-Key | header | string | null | No | nullable |
Responses
200
Successful Response
application/json
Resolved schema:
{
"properties": {
"endpoint_id": {
"type": "string",
"title": "Endpoint Id"
},
"verified": {
"type": "boolean",
"title": "Verified"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"type": "object",
"required": [
"endpoint_id",
"verified"
],
"title": "WebhookVerifyResponse"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
endpoint_id | string | Yes | ||
verified | boolean | Yes | ||
error | string | null | No | nullable |
401
No credentials, or the Bearer token / X-API-Key is invalid.
No response body.
403
The account is disabled, or a guest token was used; or the endpoint belongs to another account.
No response body.
404
Webhook endpoint not found.
No response body.
422
Validation Error
application/json
Resolved schema:
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
detail | array<object> | No | ||
detail[] | object | No | ||
detail[].loc | array<string | integer> | No | ||
detail[].loc[] | string | integer | No | ||
detail[].msg | string | No | ||
detail[].type | string | No |