Catalog

List subscribable webhook event types

Experimental. This endpoint is still settling — its request and response shape may change without a deprecation cycle.

Returns every event type Firsty can deliver to a webhook endpoint. An endpoint is configured with an explicit list of these values and there is no wildcard, so this is the set to choose from. The endpoints configured for your client, and the event types each is subscribed to, are returned by GET /webhook-configs; the payload each event type carries is documented under the Webhooks tag.

get/catalog/webhook-event-types

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Responses

200List of webhook event typesapplication/json

Show response body

dataarray of objectrequired

Show properties

eventTypestringrequired

Value to subscribe a webhook endpoint to.

401Unauthorized - missing or invalid API key 403Forbidden - client does not have access to this resource 429Rate limit exceeded 500Internal server error

Request

curl https://connect.firsty.app/api/v3/catalog/webhook-event-types \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

fetch('https://connect.firsty.app/api/v3/catalog/webhook-event-types', {
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN'
  }
})

requests.get(
    "https://connect.firsty.app/api/v3/catalog/webhook-event-types",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.firsty.app/api/v3/catalog/webhook-event-types', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN'
  ]
]);

package main

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

func main() {
	requestUrl := "https://connect.firsty.app/api/v3/catalog/webhook-event-types"

	req, _ := http.NewRequest("GET", requestUrl, nil)

	req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

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

}

curl https://connect.test.firsty.app/api/v3/catalog/webhook-event-types \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

fetch('https://connect.test.firsty.app/api/v3/catalog/webhook-event-types', {
  headers: {
    Authorization: 'Bearer YOUR_ACCESS_TOKEN'
  }
})

requests.get(
    "https://connect.test.firsty.app/api/v3/catalog/webhook-event-types",
    headers={
      "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    }
)

$client = new GuzzleHttp\Client();

$response = $client->request('GET', 'https://connect.test.firsty.app/api/v3/catalog/webhook-event-types', [
  'headers' => [
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN'
  ]
]);

package main

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

func main() {
	requestUrl := "https://connect.test.firsty.app/api/v3/catalog/webhook-event-types"

	req, _ := http.NewRequest("GET", requestUrl, nil)

	req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

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

}

Response

{
  "data": [
    {
      "eventType": "package.usage.threshold"
    }
  ]
}

{
  "type": "https://developers.firsty.app/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing bearer token"
}