API Reference
Log In
API Reference

Get the outbound webhook configuration

post
https://api.caniphish.com/api/v3/integrations/webhooks/get-webhook

Returns the webhook config with the custom header value redacted. The events.* keys use the getWebhookEventTypes vocabulary (emailReported, payloadClicked, deliveryFailed, trainingFailed) so the response can be fed straight back into updateWebhook.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The CanIPhish tenant identifier.

Responses

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago