Webhooks
Overview
This set of endpoints allows you to do all kinds of operations on your community webhooks. Learn more about how webhooks work and which events are available on our product documentation.
API Reference
List all webhooks of your community
get
/public/communities/{subdomain}/webhooks
Path parameters
subdomainstringrequired
Header parameters
x-api-keystringrequired
Responses
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
401
403
404
409
429
500
Create a new webhook
post
/public/communities/{subdomain}/webhooks
Path parameters
subdomainstringrequired
Header parameters
x-api-keystringrequired
Body
namestringrequired
uristring urirequired
activebooleanrequired
eventsenum[]required
Responses
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
401
403
404
409
429
500
Delete a webhook
delete
/public/communities/{subdomain}/webhooks/{webhookId}
Path parameters
webhookIdstring uuidrequired
subdomainstringrequired
Header parameters
x-api-keystringrequired
Responses
application/json
application/json
application/json
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
401
403
404
409
429
500
No body
Update a webhook
patch
/public/communities/{subdomain}/webhooks/{webhookId}
Path parameters
webhookIdstring uuidrequired
subdomainstringrequired
Header parameters
x-api-keystringrequired
Body
namestring
activeboolean
uristring uri
eventsenum[]
Responses
application/json
application/json
application/json
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
401
403
404
409
429
500
No body
List available event types a webhook can subscribe to
get
/public/communities/{subdomain}/webhooks-event-types
Path parameters
subdomainstringrequired
Header parameters
x-api-keystringrequired
Responses
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
401
403
404
409
429
500
List events a webhook is subscribed to
get
/public/communities/{subdomain}/webhooks/{webhookId}/events
Path parameters
subdomainstringrequired
webhookIdstring uuidrequired
Query parameters
limitnumber
pagenullable number
statusFilterenum[]required
Header parameters
x-api-keystringrequired
Responses
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
200
400
401
403
404
409
429
500
Last updated
Was this helpful?