Get webhook events.

get

https://api.personio.de/v2/webhooks/{id}/events

Returns events for a specific webhook. Only events in the last 30 days will be included. This endpoint requires the personio:webhooks:read scope.

Path Params

string

required

The unique identifier of the webhook whose events are to be retrieved.

Query Params

occurred_at.gte

date-time

The start date for filtering events by occurred date. Only events occurred on or after this date will be included.

occurred_at.lte

date-time

The end date for filtering events by occurred date. Only events occurred on or before this date will be included.

event_name

string

Enables filtering by event name. Refer to the event catalog for a list of valid event names.

limit

integer

1 to 200

Defaults to 100

The amount of resources to be returned per one request. It can range between 1 and 200, and the default is 100.

cursor

string

The pagination cursor to navigate over to the next list of resources. If you pass a specific limit to your request, or you rely on the default value of the number of resources to be returned, then your subsequent call has to include the cursor in order to retrieve the next list of resources. If cursor is missing, the first page is returned.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Successful list of all webhooks events response.

401The webhook could not be created due to invalid authentication.

403Access to the webhook is forbidden.

404The webhook could not be found.

422The filters specified with the request are faulty.