Get a Webhook by ID

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

webhook_idstring

The webhook's id.

Response Body

curl -X GET "https://api.sandbox.spherepay.co/v1/webhook/{{webhook_id}}"

fetch("https://api.sandbox.spherepay.co/v1/webhook/{{webhook_id}}")

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.sandbox.spherepay.co/v1/webhook/{{webhook_id}}"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.sandbox.spherepay.co/v1/webhook/{{webhook_id}}"

response = requests.request("GET", url)

print(response.text)

{
  "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": "0",
      "status": "failing",
      "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-20T21:30:01.878Z",
      "created": "2025-04-10T21:21:33.705Z"
    }
  },
  "ts": "2025-04-20T21:49:46.697Z",
  "request": "request_885465cf48e240f7abca4650d8de2125"
}

{
  "ok": false,
  "object": "error",
  "statusCode": 404,
  "error": "webhook/not-found",
  "message": "Webhook webhook_868e8a70c8f24aed9e56405429790307a not found",
  "data": null,
  "ts": "2025-04-20T21:50:18.854Z",
  "request": "request_35fbf5130f104c83bea6ef8d84346550"
}