3 endpoints

Webhooks

Webhook endpoints and event subscriptions

GET

List webhook endpoints

/webhooks

Retrieve all configured webhook endpoints.

Code Examples

curl -X GET "https://api.pipesolar.com/v1/webhooks" \
  -H "Authorization: Bearer ps_live_..." \
  -H "Content-Type: application/json"

Playground

GET/webhooksTry it
POST

Create a webhook endpoint

/webhooks

Register a new URL to receive webhook events.

Request Body

application/json

urlstringrequired

Webhook URL

Example: "https://example.com/webhooks/pipesolar"

eventsarrayrequired

Event types to subscribe to

Example: "[\"panel.created\", \"alert.triggered\"]"

secretstring

Signing secret for verification

Code Examples

curl -X POST "https://api.pipesolar.com/v1/webhooks" \
  -H "Authorization: Bearer ps_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhooks/pipesolar",
  "events": "[\"panel.created\", \"alert.triggered\"]",
  "secret": "example"
}'

Playground

POST/webhooksTry it
DELETE

Delete a webhook endpoint

/webhooks/{webhook_id}

Remove a webhook endpoint and stop receiving events.

Parameters

ParameterTypeDescription
webhook_idrequired
stringThe webhook ID

Code Examples

curl -X DELETE "https://api.pipesolar.com/v1/webhooks/123" \
  -H "Authorization: Bearer ps_live_..." \
  -H "Content-Type: application/json"

Playground

DELETE/webhooks/{webhook_id}Try it
webhook_id