Webhooks

Notify your application when specific events occur in your Skool community

Get Webhooks

get

Query parameters

session_idstringRequired

Header parameters

x-api-secretstringRequired

Responses

200

Successful Response

application/json

idstringRequired

422

Validation Error

application/json

get

/v1/webhooks/

HTTPcURLJavaScriptPython

GET /v1/webhooks/?session_id=text HTTP/1.1
x-api-secret: text
Accept: */*

[
  {
    "id": "text"
  }
]

Create Webhook

post

Query parameters

session_idstringRequired

Header parameters

x-api-secretstringRequired

Body

application/json

urlstringRequired

groupstringRequired

Responses

201

Successful Response

application/json

404

Group was not found

422

Validation Error

application/json

post

/v1/webhooks/

HTTPcURLJavaScriptPython

POST /v1/webhooks/?session_id=text HTTP/1.1
x-api-secret: text
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "url": "text",
  "group": "text",
  "events": [
    "post"
  ]
}

{
  "id": "text"
}

Delete Webhook

delete

Path parameters

webhook_idstringRequired

Header parameters

x-api-secretstringRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/v1/webhooks/{webhook_id}

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/{webhook_id} HTTP/1.1
x-api-secret: text
Accept: */*

No content