InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
DELETE
/v1/webhooks/endpoints/{endpoint_id}

Deletes the endpoint and its delivery history. Deliveries still waiting are dropped.

Needs scope webhooks:write.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

endpoint_id*string

The endpoint's id, from List webhook endpoints.

Response Body

iohr.events.v1.DeleteEndpointResponse

application/json
  1. response

iohr.events.v1.DeleteEndpointResponse

import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.events.deleteEndpoint("<endpoint_id>");  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

{}

Update a webhook endpoint PATCH

Change the address, the description or the event types, or enable and disable it. A field left out stays as it is. Needs scope `webhooks:write`.

Rotate the signing secret POST

A new signing secret, shown this once. The old one keeps signing alongside it for a day, so you can switch without missing a delivery. Needs scope `webhooks:write`.