Webhook Deliveries
Reference for the webhook_deliveries endpoints of the Surfmeter API.
Surfmeter API – Webhook Deliveries v1
The Surfmeter API lets you manage clients, users, capabilities, measurements, and organization-wide settings programmatically.
Servers
| Description | URL |
|---|---|
| https://surfmeter-server.{host}/client_admin_api/v1 | https://surfmeter-server.{host}/client_admin_api/v1 |
Webhook Deliveries
GET /webhooks/{webhook_id}/deliveries
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys. |
webhook_id |
path | string | No |
Response 200 OK
- application/json
{
"webhook_deliveries": [
{
"id": 0,
"webhook_endpoint_id": 0,
"event_id": "string",
"event_type": "string",
"status": "pending",
"attempts": 0,
"max_attempts": 0,
"next_attempt_at": "string",
"response_status": 0,
"error_message": "string",
"duration_ms": 0,
"delivered_at": "string",
"manual": true,
"created_at": "string",
"updated_at": "string"
}
],
"pagination": {
"page": 0,
"per_page": 0,
"total_count": 0
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
GET /webhooks/{webhook_id}/deliveries/{id}
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys. |
id |
path | string | No | ||
webhook_id |
path | string | No |
Response 200 OK
- application/json
{
"webhook_delivery": {
"id": 0,
"webhook_endpoint_id": 0,
"event_id": "string",
"event_type": "string",
"status": "pending",
"attempts": 0,
"max_attempts": 0,
"next_attempt_at": "string",
"response_status": 0,
"error_message": "string",
"duration_ms": 0,
"delivered_at": "string",
"manual": true,
"created_at": "string",
"updated_at": "string",
"payload": {
"id": "string",
"type": "string",
"timestamp": "string",
"data": {}
},
"response_body": "string",
"rendered_body": "string",
"payload_format": "standard",
"rendered_content_type": "string"
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
POST /webhooks/{webhook_id}/deliveries/{id}/redeliver
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ApiKeyAuth |
header | string | N/A | No | API key used on every request. Create keys in the Surfmeter Dashboard under Keys → Surfmeter API Keys. |
id |
path | string | No | ||
webhook_id |
path | string | No |
Response 200 OK
- application/json
{
"webhook_delivery": {
"id": 0,
"webhook_endpoint_id": 0,
"event_id": "string",
"event_type": "string",
"status": "pending",
"attempts": 0,
"max_attempts": 0,
"next_attempt_at": "string",
"response_status": 0,
"error_message": "string",
"duration_ms": 0,
"delivered_at": "string",
"manual": true,
"created_at": "string",
"updated_at": "string",
"payload": {
"id": "string",
"type": "string",
"timestamp": "string",
"data": {}
},
"response_body": "string",
"rendered_body": "string",
"payload_format": "standard",
"rendered_content_type": "string"
}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.Schema of the response body
Schemas
WebhookDeliveryIndexResponse
| Name | Type |
|---|---|
pagination |
Properties: page, per_page, total_count |
webhook_deliveries |
Array<Properties: id, webhook_endpoint_id, event_id, event_type, status, attempts, max_attempts, next_attempt_at, response_status, error_message, duration_ms, delivered_at, manual, created_at, updated_at> |
WebhookDeliveryRedeliverResponse
| Name | Type |
|---|---|
webhook_delivery |
Properties: id, webhook_endpoint_id, event_id, event_type, status, attempts, max_attempts, next_attempt_at, response_status, error_message, duration_ms, delivered_at, manual, created_at, updated_at, payload, response_body, rendered_body, payload_format, rendered_content_type |
WebhookDeliveryShowResponse
| Name | Type |
|---|---|
webhook_delivery |
Properties: id, webhook_endpoint_id, event_id, event_type, status, attempts, max_attempts, next_attempt_at, response_status, error_message, duration_ms, delivered_at, manual, created_at, updated_at, payload, response_body, rendered_body, payload_format, rendered_content_type |
Security schemes
<tr>
<td>ApiKeyAuth</td>
<td>apiKey</td>
<td></td>
<td>API key used on every request. Create keys in the Surfmeter Dashboard
under Keys → Surfmeter API Keys.
</tbody>
| Name | Type | Scheme | Description |
|---|