STstreampay
Webhooks

Get Webhook

Changed on

Get a webhook by its ID.

get/api/v2/webhooks/{webhook_id}

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

webhook_idstring uuid required

Response

Successful Response

idstring uuid

Unique identifier (UUID) of the webhook.

urlstring uri

HTTPS URL that receives event notifications.

namestring nullable

Label to tell webhooks apart.

enabledboolean

Whether events are delivered to this webhook.

health_status'ENABLED' | 'WARNING' | 'DISABLED' | 'BLOCKED'

Computed health status for merchant webhook list UI.

created_bystring uuid

ID of the user who created the webhook.

Changes