Handling Webhooks

Once you create a webhook, we will start sending webhook events shortly after they occur.

Vamp sends webhooks as a POST request containing a JSON object payload.

Accepting the Request

Vamp expects a 200 status code to be returned from the webhook endpoint you provided.

The connection will time out after two seconds, therefore you should return a response prior to performing any long-running processes.

In the event a 200 status is not returned or the connection times out, we will try to send the webhook again in two-minute intervals for up to ten minutes.

After ten minutes, the webhook will not be attempted again. However, you can still review the payload in the webhook logs.

Bearer Token

After you create your webhook you will be redirected to the Edit Webhook screen.

There, you will see a read-only Bearer Token field.

Vamp will send this Bearer token in the Authorization header with every webhook request. You may check requests against this token to verify the webhook originated from Vamp.

Webhook Payload

The webhook payload will contain a JSON object with this format:

{
  "event" : "EVENT_NAME"
  "object" : "OBJECT_NAME"
  "OBJECT_NAME" : {
    ...OBJECT_DATA
  }
}

For example:

{
  "event" : "guide.created"
  "object" : "guide"
  "guide" : {
    "id": "01jpnf7a0zwp4r55nwjs95hfr3",
    "url": "https:\/\/vamp.bot\/i\/c327cb4a-40f6-4516-be61-e6e064d18f09",
    "name": "EarBuds Product Feedback",
    ...
  }
}

The full GuideResource and InterviewResource objects can be found in Vamp's API Documentation.