Plugin webhooks

Deliver outside events to a plugin enabled in your organization, and what the endpoint checks before the plugin sees them.

Veyra Docs TeamUpdated 1 min readVersion 3 · History

A plugin that declares the webhook capability receives events from outside at:

HTTP
POST https://intelligence-api.veyra.so/api/plugins/{pluginId}/webhooks/{endpointKey}

endpointKey names one of the endpoints the plugin declares in its manifest. The plugin's settings page shows its addresses.

What Veyra checks first

Check If it fails
The plugin exists. 404
The plugin is ready (enabled and started). 400 with its current status
The plugin declares the webhook capability and this endpoint. 400 or 404

The plugin then verifies the request in its own way (for example a signature from the sending service) and decides what to do with it. Its documentation describes the payload it expects.

Authentication

How a plugin webhook is authenticated is up to the plugin. Prefer plugins that verify a signature from the sender; the endpoint address alone should not be treated as a secret.

See Plugins in the API reference.

InboundPluginsWebhooks