v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Update (Disable) Webhooks

Use this endpoint to update or disable webhooks.

patch/v1/webhooks/{id}

Path parameters

idstring required

the encrypted id of the webhook. see the GET end point method

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. Possible Values: application/json application/x-www-form-urlencoded

Request body

enabledboolean

true/false to enable or disable the web hook

event_typesstring[]

Event that will trigger the web hook. One of those values: invoice.created, charge.created, subscription.created, subscription.updated, plan.created, plan.updated, plan.deleted, discount.created, discount.deleted, customer.created, customer.updated, customer.deleted, customer.card.added, customer.card.updated, customer.card.deleted, dispute.created, dispute.updated, refund.created, token.created, charge.captured charge.voided, subscription.cancelled, invoice.charge.success, invoice.charge.failed, dispute.won, dispute.lost, order.created, order.canceled, order.charged, order.charged.failure

urlstring

Url that will be invoked when event occurs

Response

200

Example response

{
  "data": {
    "object": "WebHook",
    "id": "A0jnNvqjDDRK34kl",
    "event_types": [
      {
        "event_type": "plan.created"
      }
    ],
    "url": "https://testdashboard.payarc.net/api/create-webhook",
    "created_at": 1726064305,
    "updated_at": 1726064305,
    "enabled": true
  }
}