API Reference
Become a Partner

Send a test event with custom payload.

post
https://api.personio.de/v2/webhooks//test-event

Triggers a test event with a specific event type and custom payload data for a webhook. The event must be enabled for the webhook. Requires the personio:webhooks:write scope.

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

The unique identifier of the webhook to send the test event to.

Body Params
string
required

The name of the event to send (e.g., "person.created", "person.updated"). Must be one of the events enabled for this webhook.

payload_data
object

Key-value pairs using dot notation for nested fields (e.g., "person.id" becomes {"person": {"id": "value"}}). Required fields vary by event type (e.g., person events need "person.id", document events need "document.id" and "document.owner.id"). Refer to the event catalog for all available events.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

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

Updated 3 months ago