client.webhooks

These methods manage endpoints. To verify the deliveries themselves, see deutero.webhooks and the Receiving webhooks guide.

list_event_types()

client.webhooks.list_event_types() -> WebhookEventTypeListOut

Every event type you can subscribe to, with the fields its payload carries, plus the envelope format and signature headers. Returns WebhookEventTypeListOut.

list()

client.webhooks.list() -> WebhookListOut

Every endpoint in your organization, newest first. Secrets are omitted. Returns WebhookListOut.

create()

client.webhooks.create(*, label: str, url: str, events: list[str] | None = None, enabled: bool | None = None) -> WebhookCreatedOut

Subscribe a URL to organization events.

The response carries the signing secret. This is the only time it’s shown, so store it before doing anything else.

str

required

How you’ll recognize this endpoint in the list.

str

required

A publicly reachable http(s) URL that receives the POSTs.

list[str]

Event types to subscribe to. Omitted or empty subscribes to every event.

bool

default:"True"

Whether deliveries start immediately.

Returns WebhookCreatedOut, with webhook and signing_secret.

update()

client.webhooks.update(webhook_id, *, label=None, url=None, events=None, enabled=None) -> WebhookOut

Update an endpoint. Only the arguments you pass change; events replaces the whole list. Set enabled=False to pause deliveries. Returns WebhookOut.

delete()

client.webhooks.delete(webhook_id) -> WebhookDeleteOut

Permanently delete an endpoint, its secret and its delivery log. To pause deliveries instead, use update() with enabled=False. Returns WebhookDeleteOut.

rotate_secret()

client.webhooks.rotate_secret(webhook_id) -> WebhookSecretOut

Mint a new signing secret. The previous secret stops verifying immediately, so deploy the new one to your receiver straight away. Returns WebhookSecretOut.

list_deliveries()

client.webhooks.list_deliveries(
    webhook_id,
    *,
    event_type: str | None = None,
    success: bool | None = None,
    external_participant_id: str | None = None,
    limit: int | None = None,
    offset: int | None = None,
) -> WebhookDeliveryListOut

An endpoint’s delivery log, newest first.

str

Only deliveries of this event type.

bool

True for only successes, False for only failures.

str

Only deliveries about this participant ID of yours.

int

default:"50"

Page size.

int

Page offset.

Returns WebhookDeliveryListOut.

Client

Study setup

Recruitment

Simulation

Results

Organization

Utilities

list_event_types()

list()

create()

update()

delete()

rotate_secret()

list_deliveries()

​list_event_types()

​list()

​create()

​update()

​delete()

​rotate_secret()

​list_deliveries()

list_event_types()

list()

create()

update()

delete()

rotate_secret()

list_deliveries()