API product catalogDeveloper Platform, Sandbox & Key Management

List webhooks

Developer Platform, Sandbox & Key Management

GET

/webhooks

List webhooks

Sandbox availablelistWebhooks

Returns all registered webhook endpoints for your partner account.

Parameters

This endpoint has no path or query parameters.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

webhooksobject[]

webhooks[].idstring

Unique webhook ID.

Example: "wh_abc123"

webhooks[].urlstring

Example: "https://yourapp.com/webhooks/mystocks"

webhooks[].eventsstring[]

Subscribed event types.

webhooks[].statusactive | disabled

Response codes

200Webhook list.

Sandbox playground

Read-only sandbox request

Sandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/webhooks

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "webhooks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "wh_abc123",
            "description": "Unique webhook ID."
          },
          "url": {
            "type": "string",
            "format": "uri",
            "example": "https://yourapp.com/webhooks/mystocks"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Subscribed event types."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled"
            ]
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/webhooks' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

POST /upgrade-request

POST /webhooks