Vaartix.Webhooks (vaartix v0.1.0)

Copy Markdown View Source

Webhook endpoints. Needs a full-access key. To check incoming requests, see Vaartix.Webhook.verify/4.

Summary

Functions

Create an endpoint: %{url: ..., events: [...]}. The response includes the signing secret, shown only once.

Recent deliveries, newest first. Option: :limit.

One endpoint.

All endpoints.

Delete an endpoint.

Send a delivery again, with the same webhook-id.

Replace the signing secret. The old one stops working immediately.

Change the URL or events, or turn the endpoint off (status: "disabled") and on.

Functions

create(client, params)

Create an endpoint: %{url: ..., events: [...]}. The response includes the signing secret, shown only once.

deliveries(client, id, opts \\ [])

Recent deliveries, newest first. Option: :limit.

get(client, id)

One endpoint.

list(client)

All endpoints.

remove(client, id)

Delete an endpoint.

retry_delivery(client, id, delivery_id)

Send a delivery again, with the same webhook-id.

rotate_secret(client, id)

Replace the signing secret. The old one stops working immediately.

update(client, id, changes)

Change the URL or events, or turn the endpoint off (status: "disabled") and on.