List webhook event types
curl --request GET \
--url https://api.scrip.dev/v1/webhook-event-types \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scrip.dev/v1/webhook-event-types"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scrip.dev/v1/webhook-event-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/webhook-event-types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"category": "movement",
"description": "A balance increased: a credit, a reward, or a settle.",
"type": "balance.credited"
}
],
"pagination": {
"has_more": true,
"next_cursor": "YWJjMTIz"
}
}
Webhooks
List webhook event types
List every webhook event type with its category and a sample data object.
A catalog list does not accept created_after or created_before.
GET
/
v1
/
webhook-event-types
List webhook event types
curl --request GET \
--url https://api.scrip.dev/v1/webhook-event-types \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.scrip.dev/v1/webhook-event-types"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.scrip.dev/v1/webhook-event-types', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scrip.dev/v1/webhook-event-types"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"category": "movement",
"description": "A balance increased: a credit, a reward, or a settle.",
"type": "balance.credited"
}
],
"pagination": {
"has_more": true,
"next_cursor": "YWJjMTIz"
}
}
Returns every webhook event type. Each row carries the
type, its category, a one-sentence description, and a sample_payload. The response uses the standard list shape, with data and pagination.
Use this call to find the event types you can subscribe an endpoint to, and to see the payload shape for each one before you write a handler. Pass any type from the list as the event_type when you send a test webhook.
For the meaning of each event and how to read a payload, see Webhook event types in the Webhooks guide.
Authorizations
Send your API key as Authorization: Bearer <key>.