---
updatedAt: 2026-05-21T18:26:46.000Z
agentTools:
  projectIndex: https://docs.spinwheel.io/llms.txt
---

# Get a List of Webhooks

This API allows you to retrieve a list of webhooks you have subscribed to

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v1/partners/webhooks": {
      "get": {
        "operationId": "Get Webhooks List",
        "summary": "Get a List of Webhooks",
        "description": "This API allows you to retrieve a list of webhooks you have subscribed to",
        "parameters": [],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetWebhooksListResponse"
                },
                "examples": {
                  "Get a List of Webhooks": {
                    "value": {
                      "status": {
                        "code": 200,
                        "desc": "success"
                      },
                      "data": [
                        {
                          "eventType": "USER_CONNECTION_STATUS",
                          "isEnabled": true,
                          "url": "http://userloanconnection-abc.com",
                          "webhookId": "bedb3dc5-5471-4749-8938-09ffb02c8deb"
                        },
                        {
                          "webhookId": "5e92c9f3-d2ba-4a36-9133-a9c6df65615e",
                          "url": "https://webhook.site/272fe518-0a3e-4c68-98e4-31a6664e36aecdd",
                          "eventType": "USER_PAYMENT_STATUS",
                          "isEnabled": true,
                          "headers": [
                            {
                              "name": "Authorization",
                              "value": "c3BpbndoZWVsOkhUOX"
                            }
                          ]
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UnauthorizedResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not found response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotFoundResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InternalServerErrorResponse"
                }
              }
            }
          }
        },
        "tags": [
          "Partner Webhooks"
        ],
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "Webhooks",
    "description": "Welcome to Spinwheel's documentation! ",
    "version": "1.0",
    "contact": {}
  },
  "tags": [
    {
      "name": "Partner Webhooks"
    }
  ],
  "servers": [
    {
      "url": "https://sandbox-api.spinwheel.io"
    },
    {
      "url": "https://api.spinwheel.io"
    },
    {
      "url": "https://secure-api.spinwheel.io"
    },
    {
      "url": "https://secure-sandbox-api.spinwheel.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Once you've created a Spinwheel account and received credentials, you can access all of Spinwheel's APIs using a server-to-server call (in order to protect your credentials). When calling an API simply include your secretKey as a bearer token in an auth header like so: \n\n `Authorization: Bearer 8ae8d6fa-df8d-4c5d-9f9b-c4e4c10968b0`"
      }
    },
    "schemas": {
      "BadRequest": {
        "type": "object",
        "properties": {
          "code": {
            "type": "number",
            "example": 400
          },
          "desc": {
            "type": "string",
            "example": "Bad request"
          }
        },
        "required": [
          "code",
          "desc"
        ]
      },
      "BadRequestResponse": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/BadRequest"
          }
        },
        "required": [
          "status"
        ]
      },
      "Unauthorized": {
        "type": "object",
        "properties": {
          "code": {
            "type": "number",
            "example": 401
          },
          "desc": {
            "type": "string",
            "example": "Invalid private key"
          }
        },
        "required": [
          "code",
          "desc"
        ]
      },
      "UnauthorizedResponse": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/Unauthorized"
          }
        },
        "required": [
          "status"
        ]
      },
      "NotFound": {
        "type": "object",
        "properties": {
          "code": {
            "type": "number",
            "example": 404
          },
          "desc": {
            "type": "string",
            "example": "Resource not found"
          }
        },
        "required": [
          "code",
          "desc"
        ]
      },
      "NotFoundResponse": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/NotFound"
          }
        },
        "required": [
          "status"
        ]
      },
      "InternalServerError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "number",
            "example": 500
          },
          "desc": {
            "type": "string",
            "example": "Internal server error"
          }
        },
        "required": [
          "code",
          "desc"
        ]
      },
      "InternalServerErrorResponse": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/InternalServerError"
          }
        },
        "required": [
          "status"
        ]
      },
      "Message": {
        "type": "object",
        "properties": {
          "desc": {
            "type": "string",
            "example": "Example status description"
          },
          "type": {
            "enum": [
              "ERROR",
              "WARN",
              "INFO"
            ],
            "type": "string",
            "example": "ERROR"
          }
        },
        "required": [
          "desc"
        ]
      },
      "ResponseStatus": {
        "type": "object",
        "properties": {
          "code": {
            "type": "number",
            "example": 200
          },
          "desc": {
            "type": "string",
            "example": "success"
          },
          "messages": {
            "example": [
              {
                "desc": "Example description"
              }
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Message"
            }
          }
        }
      },
      "Header": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of header",
            "example": "api-key"
          },
          "value": {
            "type": "string",
            "description": "Value of header",
            "example": "key-value"
          }
        },
        "required": [
          "name",
          "value"
        ]
      },
      "GetWebhookByIdUtilityResponse": {
        "type": "object",
        "properties": {
          "isEnabled": {
            "type": "boolean",
            "description": "Indicates whether the webhook is currently active or not.",
            "example": true
          },
          "webhookId": {
            "type": "string",
            "description": "The ID of the webhook",
            "example": "067f4179-6be6-4c50-9933-89893b979f06"
          },
          "eventType": {
            "type": "string",
            "description": "The event type which triggers the webhook",
            "example": "USER_PAYMENT_STATUS"
          },
          "url": {
            "type": "string",
            "description": "Partner provided webhook URL",
            "example": "http://localhost:8000/paymentStatusWebhook"
          },
          "headers": {
            "description": "Header credentials are optional for webhooks",
            "example": [
              {
                "name": "Authorization",
                "value": "Bearer token"
              }
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Header"
            }
          }
        },
        "required": [
          "webhookId",
          "eventType",
          "url"
        ]
      },
      "GetWebhooksListResponse": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/ResponseStatus"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GetWebhookByIdUtilityResponse"
            }
          }
        },
        "required": [
          "status",
          "data"
        ]
      }
    }
  }
}
```