RYryftpay
Webhooks

Retrieve a webhook endpoint

Changed on

This is used to fetch a webhook by its unique Id

get/webhooks/{webhookId}

Request

  • Base URL
    https://sandbox-api.ryftpay.com/v1
  • URL
    https://sandbox-api.ryftpay.com/v1/webhooks/{webhookId}
  • Auth
    API key in header Authorization

Path parameters

webhookIdstring required
Example:wh_31fba123-0fef-41d6-92ad-fd7089f49f8a

Webhook Id to retrieve

Response

Webhook endpoint successfully retrieved

idstring

The unique Id for the webhook endpoint

activeboolean

Whether the endpoint is actively receiving events or not

urlstring

The URL of the webhook endpoint

eventTypesEventType[]

The event types the endpoint is receiving

createdTimestampinteger

The epoch timestamp (seconds) when the webhook endpoint was created

lastUpdatedTimestampinteger

The epoch timestamp (seconds) when the webhook endpoint was last updated

Example response

{
  "id": "wh_31fba123-0fef-41d6-92ad-fd7089f49f8a",
  "active": true,
  "url": "https://example-endpoint.com/webhook",
  "eventTypes": [
    "PaymentSession.captured",
    "PaymentSession.refunded"
  ],
  "createdTimestamp": 1470989538,
  "lastUpdatedTimestamp": 1470989538
}

Changes

  • 778890ee7e72Revision changes
    • warning

      added the new Conversion.created enum value to the / response property for the response status

    • warning

      added the new Conversion.updated enum value to the / response property for the response status