> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Signal Event

> Signal webhooks that an event has occurred.

All webhooks listening for the event will be notified.
<para />## Online Restricted: ## The Webhook agent is not available in Online by default. Access must be requested specifically when app is registered.



## OpenAPI

````yaml /openapi/rest/openapi-v3-Webhook.json post /api/v1/Webhook/{eventName}/{primaryKey}
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - Webhook
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Webhook/{eventName}/{primaryKey}:
    post:
      tags:
        - Webhook
      summary: Signal Event
      description: "Signal webhooks that an event has occurred.\n\nAll webhooks listening for the event will be notified.\r\n<para />## Online Restricted: ## The Webhook agent is not available in Online by default. Access must be requested specifically when app is registered."
      operationId: v1Webhook_SignalEvent
      parameters:
        - name: eventName
          in: path
          description: >-
            Name of event to fire. 'entity.verb' For example: 'window.closed',
            'button.clicked'.
          required: true
          schema:
            type: string
        - name: primaryKey
          in: path
          description: (Optional) Id of entity that is firing event. Can be 0 if not used.
          required: true
          schema:
            type: integer
            format: int32
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
          text/json:
            schema:
              type: object
              additionalProperties:
                type: object
          application/xml:
            schema:
              type: object
              additionalProperties:
                type: object
          text/xml:
            schema:
              type: object
              additionalProperties:
                type: object
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties:
                type: object
          application/json-patch+json:
            schema:
              type: object
              additionalProperties:
                type: object
          application/merge-patch+json:
            schema:
              type: object
              additionalProperties:
                type: object
        description: >-
          Event data. Not all the data values may be posted to the webhook,
          depending in webhook type: { 'windowName': 'foo', 'widgets': 123 }
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components: {}

````

## Related topics

- [Signal Event](/en/api/reference/restful/agent/webhook_agent/signal-event.md)
- [SuperOffice.WebApi.Data.Webhook SignalEventRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Webhook_SignalEventRequest.md)
- [NSWebhookAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSWebhookAgent.md)
- [SuperOffice.WebApi.Agents.IWebhookAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IWebhookAgent.md)
- [SuperOffice.WebApi.Agents.WebhookAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.WebhookAgent.md)
- [Webhook State change events](/en/automation/webhook/reference/state-events.md)