cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/webhooks/event-catalog' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/webhooks/event-catalog"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/webhooks/event-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"resourceType": "ORDER",
"events": [
{
"name": "order.created",
"groupKey": null
},
{
"name": "order.shipped",
"groupKey": null
}
]
},
{
"resourceType": "RETURN_ORDER",
"events": [
{
"name": "return.submitted",
"groupKey": null
}
]
},
{
"resourceType": "INVENTORY_ORDER",
"events": [
{
"name": "inventory_order.created",
"groupKey": null
}
]
},
{
"resourceType": "REPLACEMENT",
"events": [
{
"name": "replacement.submitted",
"groupKey": "replacementStatus"
},
{
"name": "order.shipped",
"groupKey": "shipmentStatus"
},
{
"name": "return.confirmed",
"groupKey": "returns"
}
]
}
]{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Webhooks
List webhook events
Returns every resource type a webhook subscription can target, and the granular event names for each. The list is static and not filtered by organization. Authenticate with Authorization: ApiKey <token>. Use events[].name as the event name when creating a subscription. groupKey is null except for REPLACEMENT, where it is replacementStatus, shipmentStatus, or returns.
GET
https://apipub.firstbasehq.com
/
api
/
v1
/
webhooks
/
event-catalog
cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/webhooks/event-catalog' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/webhooks/event-catalog"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/webhooks/event-catalog', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"resourceType": "ORDER",
"events": [
{
"name": "order.created",
"groupKey": null
},
{
"name": "order.shipped",
"groupKey": null
}
]
},
{
"resourceType": "RETURN_ORDER",
"events": [
{
"name": "return.submitted",
"groupKey": null
}
]
},
{
"resourceType": "INVENTORY_ORDER",
"events": [
{
"name": "inventory_order.created",
"groupKey": null
}
]
},
{
"resourceType": "REPLACEMENT",
"events": [
{
"name": "replacement.submitted",
"groupKey": "replacementStatus"
},
{
"name": "order.shipped",
"groupKey": "shipmentStatus"
},
{
"name": "return.confirmed",
"groupKey": "returns"
}
]
}
]{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Prefix the value with "ApiKey" to indicate the custom authorization type
Response
Webhook event catalog, in display order