Webhooks
Manage webhooks
Manage webhooks
List webhooks
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/webhooks"{
"data": [
{
"id": "string",
"url": "http://example.com",
"events": [
"string"
],
"active": true,
"description": "string",
"deliveryCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}Create a webhook
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/webhooks" \ -H "Content-Type: application/json" \ -d '{ "url": "http://example.com", "events": [ "question.created", "question.updated" ] }'{
"data": {
"id": "string",
"url": "http://example.com",
"events": [
"string"
],
"active": true,
"description": "string",
"secret": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}Get webhook
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Webhook ID
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/webhooks/string"{
"data": {
"id": "string",
"url": "http://example.com",
"events": [
"string"
],
"active": true,
"description": "string",
"deliveryCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}Update a webhook
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://app.thefaq.app/api/v1/string/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"id": "string",
"url": "http://example.com",
"events": [
"string"
],
"active": true,
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}Delete a webhook
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X DELETE "https://app.thefaq.app/api/v1/string/webhooks/string"{
"data": {
"id": "string",
"deleted": true
}
}Send test ping
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/webhooks/string/test"{
"data": {
"deliveryId": "string",
"event": "ping",
"message": "string"
}
}List webhook deliveries
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Query Parameters
value <= 100Cursor for next page
Response Body
application/json
curl -X GET "https://app.thefaq.app/api/v1/string/webhooks/string/deliveries"{
"data": [
{
"id": "string",
"event": "string",
"statusCode": 0,
"responseMs": 0,
"success": true,
"error": "string",
"attempt": 0,
"maxAttempts": 0,
"createdAt": "2019-08-24T14:15:22Z"
}
],
"meta": {
"nextCursor": "string"
}
}Replay a delivery
Authorization
BearerAuth API key authentication. Get your key from the dashboard under Settings > API Keys.
In: header
Path Parameters
Delivery ID to replay
Response Body
application/json
curl -X POST "https://app.thefaq.app/api/v1/string/webhooks/string/deliveries/string/replay"{
"data": {
"deliveryId": "string",
"message": "string"
}
}