Update webhook configuration

Request

Update the webhook configuration for this sponsor.

Only the fields provided in the request body will be updated. The webhook secret cannot be changed via this endpoint.

Security

APIKeyHeader

Bodyapplication/jsonrequired

urlstring or null(Url)

Any of:

New webhook endpoint URL

[ 1 .. 2083 ] characters

string (uri)

eventsArray of strings or null(Events)

Any of:

New list of event types to subscribe to.

curl -i -X PATCH \
  https://pdp.seqino.dev/api/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://api.example.com/webhooks/pdp",
    "events": [
      "invoice.created"
    ]
  }'

Responses

Webhook updated successfully

Bodyapplication/json

webhook_idstring(Webhook Id)required

Unique webhook identifier

urlstring(Url)required

Webhook endpoint URL

eventsArray of strings(Events)required

Subscribed event types

is_activeboolean(Is Active)required

Whether the webhook is active

created_atstring, (date-time)(Created At)required

Creation timestamp

last_triggered_atstring or null(Last Triggered At)

Any of:

Last time the webhook was triggered

string (date-time)

Response

{
  "webhook_id": "string",
  "url": "string",
  "events": [
    "string"
  ],
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_triggered_at": "2019-08-24T14:15:22Z"
}