AimRank Webhooks API
The Webhooks API from AimRank — 6 operation(s) for webhooks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aimrank-io:aimrank-io-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AimRank Webhooks API
description: Ranking-as-a-Service API — Turn binary comparisons into calibrated rankings with Glicko-2, Bradley-Terry, TrueSkill, and cross-domain transfer learning. Includes webhooks, API keys, RLHF exports, and embeddable widgets.
version: 4.12.0
tags:
- name: Webhooks
paths:
/api/v1/webhooks/events:
get:
tags:
- Webhooks
summary: List Supported Events
description: List all supported webhook events.
operationId: list_supported_events_api_v1_webhooks_events_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/api/v1/webhooks:
get:
tags:
- Webhooks
summary: List Webhooks
description: List all webhooks for the current user.
operationId: list_webhooks_api_v1_webhooks_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/WebhookResponse'
type: array
title: Response List Webhooks Api V1 Webhooks Get
post:
tags:
- Webhooks
summary: Create Webhook
description: 'Create a new webhook.
The webhook will be called whenever the specified events occur.
If you generate a secret, it will be used to sign payloads for verification.
Requires Pro plan or higher.'
operationId: create_webhook_api_v1_webhooks_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCreate'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCreatedResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/webhooks/{webhook_id}:
get:
tags:
- Webhooks
summary: Get Webhook
description: Get details of a specific webhook.
operationId: get_webhook_api_v1_webhooks__webhook_id__get
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
title: Webhook Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Webhooks
summary: Update Webhook
description: Update a webhook.
operationId: update_webhook_api_v1_webhooks__webhook_id__patch
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
title: Webhook Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Webhooks
summary: Delete Webhook
description: Delete a webhook.
operationId: delete_webhook_api_v1_webhooks__webhook_id__delete
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
title: Webhook Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/webhooks/{webhook_id}/test:
post:
tags:
- Webhooks
summary: Test Webhook
description: 'Send a test event to the webhook.
This sends a ''test.ping'' event to verify the webhook is working.'
operationId: test_webhook_api_v1_webhooks__webhook_id__test_post
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
title: Webhook Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/webhooks/{webhook_id}/deliveries:
get:
tags:
- Webhooks
summary: List Deliveries
description: List recent delivery attempts for a webhook.
operationId: list_deliveries_api_v1_webhooks__webhook_id__deliveries_get
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
title: Webhook Id
- name: limit
in: query
required: false
schema:
type: integer
default: 20
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WebhookDeliveryResponse'
title: Response List Deliveries Api V1 Webhooks Webhook Id Deliveries Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/webhooks/{webhook_id}/rotate-secret:
post:
tags:
- Webhooks
summary: Rotate Secret
description: 'Rotate the webhook secret.
⚠️ The new secret is only shown once! Update your integration immediately.'
operationId: rotate_secret_api_v1_webhooks__webhook_id__rotate_secret_post
parameters:
- name: webhook_id
in: path
required: true
schema:
type: string
title: Webhook Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCreatedResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
WebhookCreatedResponse:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
url:
type: string
title: Url
events:
items:
type: string
type: array
title: Events
ranking_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Ranking Ids
is_active:
type: boolean
title: Is Active
is_healthy:
type: boolean
title: Is Healthy
last_triggered_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Triggered At
last_status_code:
anyOf:
- type: integer
- type: 'null'
title: Last Status Code
consecutive_failures:
type: integer
title: Consecutive Failures
total_deliveries:
type: integer
title: Total Deliveries
failed_deliveries:
type: integer
title: Failed Deliveries
created_at:
type: string
format: date-time
title: Created At
secret:
anyOf:
- type: string
- type: 'null'
title: Secret
type: object
required:
- id
- name
- url
- events
- ranking_ids
- is_active
- is_healthy
- last_triggered_at
- last_status_code
- consecutive_failures
- total_deliveries
- failed_deliveries
- created_at
title: WebhookCreatedResponse
description: Response when creating a webhook - includes secret.
WebhookResponse:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
url:
type: string
title: Url
events:
items:
type: string
type: array
title: Events
ranking_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Ranking Ids
is_active:
type: boolean
title: Is Active
is_healthy:
type: boolean
title: Is Healthy
last_triggered_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Triggered At
last_status_code:
anyOf:
- type: integer
- type: 'null'
title: Last Status Code
consecutive_failures:
type: integer
title: Consecutive Failures
total_deliveries:
type: integer
title: Total Deliveries
failed_deliveries:
type: integer
title: Failed Deliveries
created_at:
type: string
format: date-time
title: Created At
type: object
required:
- id
- name
- url
- events
- ranking_ids
- is_active
- is_healthy
- last_triggered_at
- last_status_code
- consecutive_failures
- total_deliveries
- failed_deliveries
- created_at
title: WebhookResponse
WebhookCreate:
properties:
name:
type: string
maxLength: 255
minLength: 1
title: Name
url:
type: string
maxLength: 2048
minLength: 10
title: Url
events:
items:
type: string
type: array
title: Events
default:
- vote.created
ranking_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Ranking Ids
generate_secret:
type: boolean
title: Generate Secret
default: true
type: object
required:
- name
- url
title: WebhookCreate
WebhookUpdate:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
url:
anyOf:
- type: string
- type: 'null'
title: Url
events:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Events
ranking_ids:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Ranking Ids
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
type: object
title: WebhookUpdate
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
WebhookDeliveryResponse:
properties:
id:
type: string
title: Id
event_type:
type: string
title: Event Type
status_code:
anyOf:
- type: integer
- type: 'null'
title: Status Code
error_message:
anyOf:
- type: string
- type: 'null'
title: Error Message
attempt_number:
type: integer
title: Attempt Number
duration_ms:
anyOf:
- type: integer
- type: 'null'
title: Duration Ms
created_at:
type: string
format: date-time
title: Created At
type: object
required:
- id
- event_type
- status_code
- error_message
- attempt_number
- duration_ms
- created_at
title: WebhookDeliveryResponse
securitySchemes:
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key