Test Webhook request

Sends test webhook request on provided URL.

Path Parameters

• webhook-uid integer required

  Possible values: >= 1

  Unique Identifier for Webhook Item

Responses

• 200
• 400
• 401
• 403

---

OK

text/html

• Schema
• Example

---

Schema

• string

EVENT DETAILS: log.access_granted_by_api_call (ID: wh_5) Event Timestamp: 2025-05-05T21:38:43Z Request Timestamp: 2025-05-05T21:38:44Z Response Timestamp: 2025-05-05T21:38:44Z Response Time: 23 ms Status: Failed (6/6 attempts)
REQUEST: URL: https://api.yourcompany.com/webhooks/test Method: POST Headers: Content-Type: application/json Content-Length: 114 User-Agent: BAS-IP-Webhook-Service/1.0 X-Webhook-Signature: de35f883b0d91c78fc8f27b8cb827a7ad4df7165460d178be47cc02fd4faa6c6 X-Webhook-Timestamp: 2025-04-29T20:39:14Z X-Webhook-Attempt: 6
Payload: { "data": { "test": "success" }, "created_at": 1745947873611, "event_id": 45, "event_type": "log.access_granted_by_api_call" }
RESPONSE: Status: 401 Login required

• Wrong webhook uid

application/json

• Schema
• Example (from schema)
• Wrong uid

---

Schema

• error string

  Error message

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong webhook uid"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...