Webhooks
List available webhook event types
List event names available to agent backends.
GET
/
v1
/
webhook-events
List available webhook event types
curl --request GET \
--url https://api.staging.relayapp.im/v1/webhook-events \
--header 'Authorization: Bearer <token>'{
"events": [
"message.sent"
],
"doc_url": "https://docs.staging.relayapp.im/guides/webhooks/events"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Response
List of available webhook event types
List of all available webhook event types
Available options:
message.sent, message.received, message.read, message.delivered, message.failed, reaction.added, reaction.removed, participant.added, participant.removed, chat.created, chat.group_name_updated, chat.group_icon_updated, chat.typing_indicator.started, chat.typing_indicator.stopped, contact.added, contact.removed, call.created, call.updated, call.ended, payment.succeeded, payment.canceled, payment.expired, location.sharing.started, location.sharing.stopped, rating.created, rating.updated, rating.deleted URL to the webhook events documentation
Allowed value:
"https://docs.staging.relayapp.im/guides/webhooks/events"⌘I
List available webhook event types
curl --request GET \
--url https://api.staging.relayapp.im/v1/webhook-events \
--header 'Authorization: Bearer <token>'{
"events": [
"message.sent"
],
"doc_url": "https://docs.staging.relayapp.im/guides/webhooks/events"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}