Management APIs/Webhooks

List Webhooks

GET

Overview

List outbound webhooks configured for the authenticated account. The response includes delivery counters and the last delivery error for troubleshooting.

Authentication

All API requests require a Bearer token in the request header.

Authorization: Bearer YOUR_API_KEY

Create and manage API keys from API Keys or use https://www.apimall.ai/api-keys.

Request

API Information

URL: GET https://gateway.apimall.ai/api/v1/webhooks

Response Example

{
  "success": true,
  "data": [
    {
      "id": 8,
      "url": "https://your-app.example.com/api/webhooks/apimall",
      "events": [
        "job.completed",
        "job.failed"
      ],
      "status": "active",
      "api_key_id": 12,
      "total_sent": 32,
      "total_failed": 1,
      "last_sent_at": "2026-03-12T08:58:00.000Z",
      "last_error": null,
      "created_at": "2026-03-10T08:05:00.000Z",
      "updated_at": "2026-03-12T08:58:00.000Z"
    }
  ],
  "request_id": "req_01HQ9M7J7X9P7Y8T6W5V4U3S2R"
}

cURL Example

curl --request GET 'https://gateway.apimall.ai/api/v1/webhooks' \
  --header 'Authorization: Bearer YOUR_API_KEY'

JavaScript Example

const API_KEY = process.env.APIMALL_API_KEY;

const response = await fetch('https://gateway.apimall.ai/api/v1/webhooks', {
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const data = await response.json();
console.log(data);

Response Parameters

Parameter	Type	Description
`success`	boolean	Whether the request completed successfully.
`data`	array	Primary response payload. Task endpoints return an object with the documented task fields; list endpoints return an array of resources or a paginated object containing `items`.
`data[].id`	integer	Numeric identifier for a returned list item.
`data[].url`	string	URL associated with a returned list item, such as a webhook destination URL.
`data[].events`	array	Webhook event types subscribed by the returned list item.
`data[].status`	string	Status value for a returned list item.
`data[].api_key_id`	integer	Associated API key ID for the returned list item when present.
`data[].total_sent`	integer	Number of successful deliveries recorded for the returned list item.
`data[].total_failed`	integer	Number of failed deliveries recorded for the returned list item.
`data[].last_sent_at`	string	Timestamp of the most recent delivery attempt for the returned list item.
`data[].last_error`	string	Most recent delivery error recorded for the returned list item, if any.
`data[].created_at`	string	Creation timestamp for a returned list item.
`data[].updated_at`	string	Last update timestamp for a returned list item.
`request_id`	string	Request identifier for debugging and support.

Error Response Example

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  },
  "request_id": "req_01HQ9M7J7X9P7Y8T6W5V4U3S2R"
}

Integration Notes

Store your API key on the server side only.

Error Codes

Common Error Codes

Status Code	Description
200	Request successful
401	API key required or invalid API key
403	API access not approved or request made on a non-gateway host
404	Resource not found
429	Rate limit exceeded
500	Internal server error

Request

curl --location --request GET 'https://gateway.apimall.ai/api/v1/webhooks' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

{
  "success": true,
  "data": [
    {
      "id": 8,
      "url": "https://your-app.example.com/api/webhooks/apimall",
      "events": [
        "job.completed",
        "job.failed"
      ],
      "status": "active",
      "api_key_id": 12,
      "total_sent": 32,
      "total_failed": 1,
      "last_sent_at": "2026-03-12T08: 58: 00.000Z",
      "last_error": null,
      "created_at": "2026-03-10T08: 05: 00.000Z",
      "updated_at": "2026-03-12T08: 58: 00.000Z"
    }
  ],
  "request_id": "req_01HQ9M7J7X9P7Y8T6W5V4U3S2R"
}