PEperk

Retrieve a webhook endpoint

Changed on

Get details for a specific webhook endpoint

get/webhooks/{id}

Request

  • Base URL
    https://api.travelperk.com
  • URL
    https://api.travelperk.com/webhooks/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Unique identifier for the webhook.

Response

200

idstring
namestring
urlstring
secretstring
statusstring
eventsstring[]
successfully_sentinteger
failed_sentinteger
error_rateinteger

Example response

{
  "id": "b42820bb-24c9-48da-bded-487681e9c851",
  "name": "invoice webhook",
  "url": "https://mycompany.com/tk_webhook",
  "secret": "some secret",
  "status": "enabled",
  "events": [
    "invoice.issued"
  ],
  "successfully_sent": 2
}

Changes