---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# Trigger webhooks for specific entities

Trigger webhooks for specific entities.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain",
          "description": "Your Deputy tenant subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ],
          "description": "Deputy region: au, eu, na, or deputy (AU default)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "WebhookTriggersTriggerRequest": {
        "type": "object",
        "properties": {
          "webhookTopic": {
            "type": "string",
            "title": "The webhook topic to trigger (e.g., \"Employee.Update\", \"Company.Insert\")"
          },
          "entityIds": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "int64"
            },
            "title": "List of entity IDs to trigger webhooks for"
          },
          "reason": {
            "type": "string",
            "title": "Reason for triggering the webhook (for audit/logging)"
          },
          "options": {
            "$ref": "#/components/schemas/modelWebhookTriggerOptions",
            "title": "Webhook trigger options"
          }
        }
      },
      "WebhookTriggersTriggerResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          },
          "data": {
            "$ref": "#/components/schemas/modelWebhookExecutionSummary"
          }
        }
      },
      "modelWebhookExecutionSummary": {
        "type": "object",
        "properties": {
          "totalProcessed": {
            "type": "integer",
            "format": "int32",
            "title": "Total number of entities processed"
          },
          "successful": {
            "type": "integer",
            "format": "int32",
            "title": "Number of successful webhook triggers"
          },
          "failedIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "title": "The list of failed id entity webhook triggers"
          },
          "topic": {
            "type": "string",
            "title": "Topic for processing hook"
          }
        },
        "title": "Summary of webhook execution"
      },
      "modelWebhookTriggerOptions": {
        "type": "object",
        "properties": {
          "forceImmediate": {
            "type": "boolean",
            "title": "Force immediate execution (bypass transaction safety)"
          },
          "bulkMode": {
            "type": "boolean",
            "title": "Use bulk mode for better performance with multiple entities"
          },
          "maxBatchSize": {
            "type": "integer",
            "format": "int32",
            "title": "Maximum batch size for bulk operations"
          }
        },
        "title": "Webhook trigger options"
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/management/v2/webhooks/trigger": {
      "post": {
        "summary": "Trigger webhooks for specific entities",
        "operationId": "WebhookTriggerV2Controller_trigger",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTriggersTriggerResponse"
                }
              }
            }
          }
        },
        "tags": [
          "Webhook Triggers"
        ],
        "description": "Trigger webhooks for specific entities.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookTriggersTriggerRequest"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
```