Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Erply webhook-configuration API

The webhook-configuration API from Erply — 2 operation(s) for webhook-configuration.

Erply webhook-configuration API is one of 64 APIs that Erply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include webhook-configuration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 2.36.5.

Requests are made against the base URL https://api-pim-eu.erply.com.

4 operations 2 paths 4 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.36.5
Base URL
https://api-pim-eu.erply.com
Authentication
API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Erply webhook-configuration API declares 5 security schemes for authenticating requests. An API key is passed in the header as accessToken (AccessToken). An API key is passed in the header as clientCode (ErplyClientCode). An API key is passed in the header as jwt (ErplyJWT). An API key is passed in the header as sessionKey (ErplySession). An API key is passed in the header as requestKey (RequestKey).

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

webhook-configuration 4
GET
/v1/webhook-configuration
Get webhook configurations
getWebhookConfigurations → 200401503
POST
/v1/webhook-configuration
Add webhook configuration
addWebhookConfiguration 1 param → 200400401503
PUT
/v1/webhook-configuration/{id}
Update existing webhook configuration
updateWebhookConfiguration 2 params → 200400401503
DELETE
/v1/webhook-configuration/{id}
Remove existing webhook configuration
removeWebhookConfiguration 1 param → 200400401503

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are models.WebhookConfiguration (9 properties), models.InputWebhookConfiguration (5 properties), models.OutputError (1 property), models.OutputOK (1 property). Each schema is shown below with its type and property counts.

models.OutputOK
object
1 property
models.WebhookConfiguration
object
9 properties
models.OutputError
object
1 property
models.InputWebhookConfiguration
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-webhook-configuration-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
Erply Assortment To Product Linking API
Erply Attributes API
Erply auth API
Erply Brand API
Erply clsf API
Erply clsf-device-properties API
Erply clsf-events API
Erply clsf-labels API
Erply Country API
Erply device API
Erply event API