Webhooks

Update a webhook

patch/tenants/{tenantId}/webhooks/{webhookId}

Request

Base URL
https://api.arkhq.io/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/arkhq-io/apis/ark-email-api/docs/tenants/:tenantId/webhooks/:webhookId/patch.ts
A function with typed inputs. Its response is checked against the schema.

tenantIdstring required

The tenant ID

webhookIdstring required

Webhook ID

namestring nullable

urlstring uri nullable

eventsstring[] nullable

allEventsboolean nullable

enabledboolean nullable

Webhook updated

successtrue required

{
  "data": {
    "id": "456"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}