Manage your webhook

Add a new webhook

Use this API request to add a new webhook.

POST https://api.spherepay.co/v1/webhook

For the full API specification, see the Sphere API Reference.

Request Example

{
    "name": "Example Webhook",
    "description": "An example webhook",
    "url": "https://example.com/webhook",
    "events": ["bankAccount.create", "wallet.create"]
}

Response Example

{
  "ok": true,
  "object": "object",
  "statusCode": 200,
  "error": null,
  "message": "success",
  "data": {
    "webhook": {
      "id": "webhook_dab187e460e54595a76f66d38b0ee624",
      "name": "Example Webhook",
      "description": "An example webhook",
      "active": true,
      "deliveryRate": "1",
      "status": "healthy",
      "events": [
        "bankAccount.create",
        "wallet.create"
      ],
      "url": "https://example.com/webhook",
      "secret": "secret_cb8dedcf79a84b04b163ec74c7146481",
      "updated": "2024-08-15T17:55:57.879Z",
      "created": "2024-08-15T17:55:57.879Z"
    }
  },
  "ts": "2024-08-15T17:55:57.888Z",
  "request": "request_778ada59642d4578af188873d0ce191b"
}

Get a webhook

Use this API request to get a webhook by its ID.

GET https://api.spherepay.co/v1/webhook/{webhook_id}

For the full API specification, see the Sphere API Reference.

Response Example

{
    "ok": true,
    "object": "object",
    "statusCode": 200,
    "error": null,
    "message": "success",
    "data": {
        "webhook": {
            "id": "webhook_868e8a70c8f24aed9e56405429790307",
            "name": "Example Webhook",
            "description": "An example webhook",
            "active": true,
            "deliveryRate": "1",
            "status": "healthy",
            "events": [
                "customer.create",
                "customer.update",
                "customer.tos.pending",
                "customer.tos.successful",
                "customer.kyc.successful",
                "bankAccount.create",
                "wallet.create"
            ],
            "url": "https://webhook.site/b14a90e9-42b6-4f99-b9f3-371538104646",
            "secret": "secret_9e0c4371b49a4662ba91d232297f5873",
            "updated": "2025-04-13T23:00:01.924Z",
            "created": "2025-04-10T21:21:33.705Z"
        }
    },
    "ts": "2025-04-13T23:26:27.246Z",
    "request": "request_2fadd66542c24fe0a5e76372792b2c38"
}

Get a list of webhooks

Use this API request to get a list of webhooks.

GET https://api.spherepay.co/v1/webhook

For the full API specification, see the Sphere API Reference.

Response Example

{
    "ok": true,
    "object": "object",
    "statusCode": 200,
    "error": null,
    "message": "success",
    "data": [{
        "webhook": {
            "id": "webhook_868e8a70c8f24aed9e56405429790307",
            "name": "Example Webhook",
            "description": "An example webhook",
            "active": true,
            "deliveryRate": "1",
            "status": "healthy",
            "events": [
                "customer.create",
                "customer.update",
                "customer.tos.pending",
                "customer.tos.successful",
                "customer.kyc.successful",
                "bankAccount.create",
                "wallet.create"
            ],
            "url": "https://webhook.site/b14a90e9-42b6-4f99-b9f3-371538104646",
            "secret": "secret_9e0c4371b49a4662ba91d232297f5873",
            "updated": "2025-04-13T23:00:01.924Z",
            "created": "2025-04-10T21:21:33.705Z"
        }
    }],
    "ts": "2025-04-13T23:26:27.246Z",
    "request": "request_2fadd66542c24fe0a5e76372792b2c38"
}

Update a webhook

Note

Coming Soon

Delete a webhook

Note

Coming Soon

Manage your webhook

On this page