Get Webhook Endpoint

Get a webhook endpoint by its encrypted id.

get/webhooks/{id}

Request

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

Path parameters

idstring required

Encrypted identifier of the web hook endpoint.<br>e.g.JnVtcmVVVEJDVEd4T3VsenhaU0VmZz17

Response

200

idstring
createdOnstring
descriptionstring
enabledboolean
urlstring

Example response

{
  "id": "JnVtcmVVVEJDVEd4T3VsenhaU0VmZz17",
  "createdOn": "2020-06-03T09:09:04.769Z",
  "description": "My Webhook",
  "enabled": true,
  "url": "https://example.com/webhook/endpoint",
  "webhookEvents": [
    {
      "transactionStatus": "COMPLETED",
      "transactionType": "PAYOUT"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.