Erply webhook API
The webhook API from Erply — 2 operation(s) for webhook.
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/erply-webhook-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
title: assignments Assortment Webhook API
contact: {}
version: 2.36.5
tags:
- name: webhook
paths:
/v1/event:
get:
security:
- ClientCode: []
- SessionKey: []
description: '# Get recorded events
Returns events that have been recently recorded for the account.
Note that event list is constantly purged, historic events are not stored.
Events are only stored if the account has a corresponding webhook configuration.'
tags:
- webhook
summary: Get recorded events
operationId: getEvents
parameters:
- description: Name of the table for the event
name: table
in: query
required: true
schema:
type: string
- description: Name of the action for the event
name: action
in: query
required: true
schema:
type: string
- description: Limit the results. Default is 20 and max is 100.
name: limit
in: query
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/models.OutputEvent'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/models.OutputError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/models.OutputError'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/models.OutputError'
/v1/webhook:
get:
security:
- ClientCode: []
- SessionKey: []
description: '# Get recently sent webhooks
Get current authenticated users recently sent webhooks.
Note that this list only includes webhooks that have been attempted to be sent in the last hour (or less).
Any webhooks that were supposed to be sent longer than 1 hour ago are not guaranteed to be returned with this request.'
tags:
- webhook
summary: Get recently sent webhooks
operationId: getWebhooks
parameters:
- description: Name of the table for the webhook
name: table
in: query
schema:
type: string
- description: Name of the action for the webhook
name: action
in: query
schema:
type: string
- description: Limit the results. Default is 20 and max is 100.
name: limit
in: query
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/models.OutputWebhook'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/models.OutputError'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/models.OutputError'
'503':
description: Service Unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/models.OutputError'
components:
schemas:
models.OutputError:
type: object
properties:
error:
type: string
example: Description of the failure
models.OutputWebhook:
type: object
properties:
action:
description: Action the action the webhook was registered for
type: string
createdAt:
description: CreatedAt time when the webhook was created
type: string
endpoint:
description: Endpoint the endpoint where the webhook is sent
type: string
eventCount:
description: EventCount number of events in the webhook
type: integer
id:
description: ID id of the webhook
type: string
lastFailure:
description: LastFailure contains the last error message if the hook send has failed
type: string
processedAt:
description: ProcessedAt time whe the webhook was last processed
type: string
status:
description: Status status of the webhook
type: string
table:
description: Table the table the webhook was registered for
type: string
tries:
description: Tries number of times the webhook was tried
type: integer
models.OutputEvent:
type: object
properties:
action:
description: action the webhook was registered for
type: string
createdAt:
description: time when the event was created into the process queue
type: string
eventDate:
description: date when the event was created in the stream
type: string
id:
description: ID of the event
type: string
processedAt:
description: time when the event was processed
type: string
rowID:
description: id of the row, when it exists
type: integer
format: int64
status:
description: if the event has been processed to a webhook
type: string
table:
description: Table the webhook was registered for
type: string
securitySchemes:
AccessToken:
type: apiKey
name: accessToken
in: header
ErplyClientCode:
type: apiKey
name: clientCode
in: header
ErplyJWT:
type: apiKey
name: jwt
in: header
ErplySession:
type: apiKey
name: sessionKey
in: header
RequestKey:
type: apiKey
name: requestKey
in: header