Fenergo

Fenergo Webhooks API

The Webhooks API from Fenergo — 4 operation(s) for webhooks.

Documentation GitHub OpenAPI

Operations 7

GET /v1/webhooks List all webhook configurations #

POST /v1/webhooks Add a webhook configuration #

DELETE /v1/webhooks/{webhookId} Delete webhook configuration #

PUT /v1/webhooks/{webhookId} Update a webhook configuration #

GET /v1/webhooks/{webhookId} Get webhook configuration #

GET /v1/webhooks/event-notification-types List all available event notification types #

GET /v1/webhooks/{webhookId}/test Test webhook availability #

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/fenergo-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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Event Notifications Webhooks API
  description: 'An API to manage event notifications webhooks.


    Webhooks allow you to build or setup integrations which subscribe to certain events from Fen-X. When one of those events is triggered, we''ll send an HTTP POST payload to the webhook''s configured URL.


    Using this API you can Add, Update, Delete and List your tenant''s webhooks. You can add app to 10 webhooks per tenant.'
  version: '1.0'
servers:
- url: /webhooks
security:
- Bearer: []
tags:
- name: Webhooks
paths:
  /v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List all webhook configurations
      description: 'This method will list all webhook configurations for specific tenant


        Required permissions:

        Following permissions are required: WebhookAccess'
      operationId: ListWebhooks
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Fenergo.Nebula.EventNotifications.Webhooks.PublicApi.V1.ListWebhooksResponse class containing webhook configuration results
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ListWebhooksResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhooksResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ListWebhooksResponse'
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
    post:
      tags:
      - Webhooks
      summary: Add a webhook configuration
      description: 'This method will add new webhook configuration for specific tenant


        The maximum number of configurations allowed is 10.


        Required permissions:

        Following permissions are required: WebhookManagement'
      operationId: AddWebhook
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Fenergo.Nebula.EventNotifications.Webhooks.PublicApi.V1.AddWebhookRequest class represents add request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AddWebhookRequest'
              description: Add a webhook.
      responses:
        '200':
          description: Fenergo.Nebula.EventNotifications.Webhooks.PublicApi.V1.AddWebhookResponse class represents new webhook configuration
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AddWebhookResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AddWebhookResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddWebhookResponse'
        '400':
          description: Bad request. The request has missing/invalid values
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
  /v1/webhooks/{webhookId}:
    delete:
      tags:
      - Webhooks
      summary: Delete webhook configuration
      description: 'This method will delete specific webhook configuration


        Required permissions:

        Following permissions are required: WebhookManagement'
      operationId: DeleteWebhook
      parameters:
      - name: webhookId
        in: path
        description: The webhook identifier.
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Webhook configuration was successfully deleted.
        '404':
          description: There is no webhook configuration for this tenant
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
    put:
      tags:
      - Webhooks
      summary: Update a webhook configuration
      description: 'This method will update specific webhook configuration


        Required permissions:

        Following permissions are required: WebhookManagement'
      operationId: UpdateWebhook
      parameters:
      - name: webhookId
        in: path
        description: The webhook identifier.
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Fenergo.Nebula.EventNotifications.Webhooks.PublicApi.V1.UpdateWebhookRequest class represents update request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateWebhookRequest'
              description: Represents a request to update a webhook.
      responses:
        '200':
          description: Webhook configuration was successfully updated.
        '400':
          description: Bad request. The request has missing/invalid values
        '404':
          description: There is no webhook configuration for this tenant
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
    get:
      tags:
      - Webhooks
      summary: Get webhook configuration
      description: 'This method will return specific webhook configuration


        Required permissions:

        Following permissions are required: WebhookAccess'
      operationId: GetWebhook
      parameters:
      - name: webhookId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Fenergo.Nebula.EventNotifications.Webhooks.PublicApi.V1.GetWebhookResponse class represents webhook configuration
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetWebhookResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetWebhookResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetWebhookResponse'
        '404':
          description: There is no webhook configuration for this tenant
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
  /v1/webhooks/event-notification-types:
    get:
      tags:
      - Webhooks
      summary: List all available event notification types
      description: 'This method will list all available event notification types.


        Required permissions:

        Following permissions are required: WebhookAccess'
      operationId: ListEventNotificationTypes
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: "Fenergo.Nebula.EventNotifications.Utils.Dto.ListEventNotificationTypesResponse class containing event notification types\n                results."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ListEventNotificationTypesResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ListEventNotificationTypesResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ListEventNotificationTypesResponse'
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
  /v1/webhooks/{webhookId}/test:
    get:
      tags:
      - Webhooks
      summary: Test webhook availability
      description: 'This method allows to check if webhook is available and prepared to receive events.


        Required permissions:

        Following permissions are required: WebhookManagement'
      operationId: TestWebhook
      parameters:
      - name: webhookId
        in: path
        description: The webhook identifier.
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Fenergo.Nebula.EventNotifications.Webhooks.PublicApi.V1.TestWebhookResponse class representing test response
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TestWebhookResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TestWebhookResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TestWebhookResponse'
        '404':
          description: There is no webhook configuration for this tenant and webhook id
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
components:
  schemas:
    DeliveryItemStatus:
      enum:
      - Successful
      - Failed
      - TimedOut
      type: string
    EventNotificationTypeDto:
      type: object
      properties:
        eventType:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        example: {}
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetWebhookResponse:
      type: object
      properties:
        webhook:
          allOf:
          - $ref: '#/components/schemas/Webhook'
          description: The Webhook information.
      additionalProperties: false
      description: Represents the response when getting a sepecific webhook.
    DeliveryTestResult:
      type: object
      properties:
        status:
          allOf:
          - $ref: '#/components/schemas/DeliveryItemStatus'
        httpStatusCode:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    TestWebhookResponse:
      type: object
      properties:
        delivery:
          allOf:
          - $ref: '#/components/schemas/DeliveryTestResult'
          description: Information about delivery.
      additionalProperties: false
      description: Represents a response when testing webhook.
    AddWebhookResponse:
      type: object
      properties:
        webhookId:
          type:
          - string
          - 'null'
          description: The identifier of the added webhook.
          example: e23494fc-1095-48eb-8c10-eb46228883f6
      additionalProperties: false
      description: The reponse when adding a webhook.
    BasicWebhook:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: The webhook name.
          example: Example webhook name
        url:
          type:
          - string
          - 'null'
          description: 'The URL webhook messages will be posted to. The content type posted

            is `application/json`.'
          example: https://www.example.com
        id:
          type:
          - string
          - 'null'
          description: The webhook identifier
          example: e23494fc-1095-48eb-8c10-eb46228883f6
        enabled:
          type: boolean
          description: Indicates if the webhook is enabled or not.
          example: true
        eventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'The collection of event types that will be delivered e.g. ["document:created","document:updated"].

            "*" represents all event types and overrides other types specified.'
          example:
          - entitydata:draftcreated_enriched
        status:
          allOf:
          - $ref: '#/components/schemas/WebhookStatus'
          description: The webhook status
        type:
          allOf:
          - $ref: '#/components/schemas/WebhookType'
          description: Webhook Type
          example: Single
        batchSize:
          type:
          - integer
          - 'null'
          description: Max batch size for single request
          format: int32
          example: 50
      additionalProperties: false
    WebhookType:
      enum:
      - Single
      - Batch
      type: string
    WebhookStatus:
      enum:
      - UserDisabled
      - Enabled
      - SystemDisabled
      - Retrying
      type: string
    ListWebhooksResponse:
      type: object
      properties:
        webHooks:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BasicWebhook'
          description: The collection of webhooks.
      additionalProperties: false
      description: Represents a response when listing webhooks.
    UpdateWebhookRequest:
      required:
      - enabled
      - eventTypes
      - url
      type: object
      properties:
        name:
          maxLength: 128
          type:
          - string
          - 'null'
          description: The name of the webhook.
          example: Example webhook name
        url:
          minLength: 1
          type: string
          description: 'The URL webhook messages will be posted to. The content type posted

            is `application/json`.'
          example: https://www.example.com
        secret:
          maxLength: 128
          type:
          - string
          - 'null'
          description: 'The webhook secret. If not specified or empty string, then the

            existing secret is retained.'
          example: secret
        enabled:
          type: boolean
          description: Indicates if the webhook is enabled or not.
          example: true
        eventTypes:
          type: array
          items:
            type: string
          description: 'The collection of event types that will be delivered e.g. ["document:created","document:updated"].

            "*" represents all event types and overrides other types specified.'
          example:
          - entitydata:draftcreated_enriched
        emailAddresses:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of email addresses which will be notified when the system disables the webhook (maximum 5 email addresses)
          example:
          - someone@example.com
        type:
          allOf:
          - $ref: '#/components/schemas/WebhookType'
          description: 'Webhook Type. Default value: Single'
          example: Single
        batchSize:
          maximum: 100
          minimum: 10
          type:
          - integer
          - 'null'
          description: Max batch size for single request
          format: int32
          example: 50
      additionalProperties: false
      description: Represents a request to update a webhook.
    ListEventNotificationTypesResponse:
      type: object
      properties:
        eventTypes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EventNotificationTypeDto'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    Webhook:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: The webhook name.
          example: Example webhook name
        url:
          type:
          - string
          - 'null'
          description: 'The URL webhook messages will be posted to. The content type posted

            is `application/json`.'
          example: https://www.example.com
        id:
          type:
          - string
          - 'null'
          description: The webhook identifier
          example: e23494fc-1095-48eb-8c10-eb46228883f6
        enabled:
          type: boolean
          description: Indicates if the webhook is enabled or not.
          example: true
        eventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'The collection of event types that will be delivered e.g. ["document:created","document:updated"].

            "*" represents all event types and overrides other types specified.'
          example:
          - entitydata:draftcreated_enriched
        status:
          allOf:
          - $ref: '#/components/schemas/WebhookStatus'
          description: The webhook status
        type:
          allOf:
          - $ref: '#/components/schemas/WebhookType'
          description: Webhook Type
          example: Single
        batchSize:
          type:
          - integer
          - 'null'
          description: Max batch size for single request
          format: int32
          example: 50
        lastDeliveries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DeliveryAttempt'
          description: Collection of last 20 webhook's deliveries
        emailAddresses:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of email addresses which will be notified when the system disables the webhook (maximum 5 email addresses)
          example:
          - someone@example.com
      additionalProperties: false
    DeliveryAttempt:
      type: object
      properties:
        when:
          type: string
          description: Timestamp of the delivery
          format: date-time
        notificationId:
          type:
          - string
          - 'null'
          description: Id of notification used in delivery attempt
          example: e23494fc-1095-48eb-8c10-eb46228883f6
        status:
          allOf:
          - $ref: '#/components/schemas/DeliveryItemStatus'
          description: Status of the delivery
          example: Succeeded
        httpStatusCode:
          type:
          - integer
          - 'null'
          description: Http status code of delivery request
          format: int32
          example: 200
      additionalProperties: false
    AddWebhookRequest:
      required:
      - enabled
      - eventTypes
      - secret
      - url
      type: object
      properties:
        name:
          maxLength: 128
          type:
          - string
          - 'null'
          description: The name of the webhook.
          example: Example webhook name
        url:
          minLength: 1
          type: string
          description: 'The URL webhook messages will be posted to. The content type posted

            is `application/json`.'
          example: https://www.example.com
        secret:
          maxLength: 128
          minLength: 1
          type: string
          description: The webhook secret.
          example: secret
        enabled:
          type: boolean
          description: Indicates if the webhook is enabled or not.
          example: true
        eventTypes:
          type: array
          items:
            type: string
          description: 'The collection of event types that will be delivered e.g. ["document:created","document:updated"].

            "*" represents all event types and overrides other types specified.'
          example:
          - entitydata:draftcreated_enriched
        emailAddresses:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of email addresses which will be notified when the system disables the webhook (maximum 5 email addresses)
          example:
          - someone@example.com
        type:
          allOf:
          - $ref: '#/components/schemas/WebhookType'
          description: 'Webhook Type. Default value: Single'
          example: Single
        batchSize:
          maximum: 100
          minimum: 10
          type:
          - integer
          - 'null'
          description: Max batch size for single request
          format: int32
          example: 50
      additionalProperties: false
      description: Add a webhook.
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header