Interface: Webhook
Defined in: schemas/v2/resources/webhook.ts:4
Webhooks are fired based on events happening on a particular campaign.
Properties
| Property | Type | Description |
|---|---|---|
last_attempted_at | string | Last date that the webhook was attempted or used. |
num_consecutive_times_failed | number | Number of times the webhook has failed consecutively, when in an error state. Examples 0 2 |
paused | boolean | true if the webhook is paused as a result of repeated failed attempts to post to uri. Set to false to attempt to re-enable a previously failing webhook. |
secret | string | Secret used to sign your webhook message body, so you can validate authenticity upon receipt. |
triggers | string[] | List of events that will trigger this webhook. See https://docs.patreon.com/#triggers-v2 Example [ 'members:pledge:create', 'members:update', 'members:pledge:delete', ] |
uri | string | Fully qualified uri where webhook will be sent Example 'https://www.example.com/webhooks/incoming' |