Test a Webhook

You can use this endpoint to see how the webhook works.

Test an already registered webhook on Goki.

POST [environmentBaseUrl]/v1/webhooks/:id/test

Path Parameters

Name	Type	Description
*	String	Identifier of the webhook

Request Body

Name	Type	Description
event*	String	The event you want to test. i.e. reservationPinGenerated

200: OK

{
    "data": {
      "request": {
        "method": "POST",
        "url": "https://example.com",
        "body": {} // The data we sent to your webhook. It can be different based on the event. Please read the webhook's page.      
      },
      "response": {}, // Your webhook response 
      "responseError": {} // The error your webhook returned (If the response status is not 2xx)
    }
}

404: Not Found Webhook not found!

{
  "error": {
     "code": 5,
     "title": "NOT_FOUND",
     "status": 404,
     "message": "Webhook not found!"
  }
}