patreon-api.ts

Appearance

Interface: Webhook ​

Defined in: schemas/v2/resources/webhook.ts:4

Webhooks are fired based on events happening on a particular campaign.

Properties ​

last_attempted_at ​

last_attempted_at: string

Defined in: schemas/v2/resources/webhook.ts:9

Last date that the webhook was attempted or used.

Format ​

date-time

num_consecutive_times_failed ​

num_consecutive_times_failed: number

Defined in: schemas/v2/resources/webhook.ts:16

Number of times the webhook has failed consecutively, when in an error state.

Examples ​

ts
0
ts
2

paused ​

paused: boolean

Defined in: schemas/v2/resources/webhook.ts:22

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 ​

secret: string

Defined in: schemas/v2/resources/webhook.ts:27

Secret used to sign your webhook message body, so you can validate authenticity upon receipt.

triggers ​

triggers: string[]

Defined in: schemas/v2/resources/webhook.ts:39

List of events that will trigger this webhook.

See ​

https://docs.patreon.com/#triggers-v2

Example ​

ts
[
   'members:pledge:create',
   'members:update',
   'members:pledge:delete',
]

uri ​

uri: string

Defined in: schemas/v2/resources/webhook.ts:46

Fully qualified uri where webhook will be sent

Format ​

uri

Example ​

ts
'https://www.example.com/webhooks/incoming'