Webhooks and events

POST `/v1/events/{event_id}/resend`

Resend Event Idempotency-Key Auth: X-API-Key

Queue an event again to every endpoint that received it (or webhookId).

Parameters of POST /v1/events/{event_id}/resend
Parameter	In	Type
`event_id` required	path	`string`
`webhookId`	query	`string \| null`
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

202 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/events/EVENT_ID/resend' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/events/EVENT_ID/resend",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/events/EVENT_ID/resend", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhook-event-types`

Event Types Auth: X-API-Key

Every webhook event type, with a description, its source and an example envelope.

Responses

200 Successful Response

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhook-event-types' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhook-event-types",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhook-event-types");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhook-events/trigger`

Trigger Idempotency-Key Auth: X-API-Key

Publish one test event of a catalog type (any type in the sandbox; live: webhook.test).

Parameters of POST /v1/webhook-events/trigger
Parameter	In	Type
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Request body TriggerBody required

Request body fields of POST /v1/webhook-events/trigger
Field	Type	Description
`type` required	`string`
`accountId`	`string \| null`

Responses

202 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhook-events/trigger' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this' \
  -H 'Content-Type: application/json' \
  -d '{"type":"string"}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhook-events/trigger",
        json={"type": "string"},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhook-events/trigger", {
  body: {"type":"string"},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhook-listeners`

Create Listener Auth: X-API-Key

Start a local-forwarding listener: its signing secret and the current cursor.

Parameters of POST /v1/webhook-listeners
Parameter	In	Type	Description
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

201 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhook-listeners' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhook-listeners",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhook-listeners", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhook-listeners/{listener_id}/events`

Listener Events Auth: X-API-Key

The tenant's events after the after cursor, each signed with the listener secret.

Parameters of GET /v1/webhook-listeners/{listener_id}/events
Parameter	In	Type
`listener_id` required	path	`string`
`after`	query	`string`
`types`	query	`string[] \| null`
`limit`	query	`integer`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhook-listeners/LISTENER_ID/events' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhook-listeners/LISTENER_ID/events",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhook-listeners/LISTENER_ID/events");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhooks`

List Webhooks Auth: X-API-Key

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhooks' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhooks",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhooks");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhooks`

Create Webhook Auth: X-API-Key

Request body CreateWebhook required

Request body fields of POST /v1/webhooks
Field	Type	Description
`url` required	`string`
`secret`	`string \| null`

Responses

201 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhooks' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com/hook"}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhooks",
        json={"url": "https://example.com/hook"},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhooks", {
  body: {"url":"https://example.com/hook"},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhooks/{webhook_id}`

Get Webhook Auth: X-API-Key

Parameters of GET /v1/webhooks/{webhook_id}
Parameter	In	Type	Description
`webhook_id` required	path	`string`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhooks/WEBHOOK_ID",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhooks/WEBHOOK_ID");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

PATCH `/v1/webhooks/{webhook_id}`

Patch Endpoint Idempotency-Key Auth: X-API-Key

Change the event filter (enabledEvents), URL or description.

Parameters of PATCH /v1/webhooks/{webhook_id}
Parameter	In	Type
`webhook_id` required	path	`string`
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Request body PatchEndpoint required

Request body fields of PATCH /v1/webhooks/{webhook_id}
Field	Type	Description
`enabledEvents`	`string[] \| null`
`url`	`string \| null`
`description`	`string \| null`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X PATCH 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "PATCH",
        "/v1/webhooks/WEBHOOK_ID",
        json={},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("PATCH", "/v1/webhooks/WEBHOOK_ID", {
  body: {},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

DELETE `/v1/webhooks/{webhook_id}`

Delete Webhook Auth: X-API-Key

Parameters of DELETE /v1/webhooks/{webhook_id}
Parameter	In	Type	Description
`webhook_id` required	path	`string`

Responses

204 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X DELETE 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "DELETE",
        "/v1/webhooks/WEBHOOK_ID",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("DELETE", "/v1/webhooks/WEBHOOK_ID", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhooks/{webhook_id}/deliveries`

List Deliveries Auth: X-API-Key

The endpoint's deliveries, newest first ({data, hasMore, nextCursor}).

Parameters of GET /v1/webhooks/{webhook_id}/deliveries
Parameter	In	Type
`webhook_id` required	path	`string`
`status`	query	`string \| null`
`eventType`	query	`string \| null`
`eventId`	query	`string \| null`
`since`	query	`string \| null`
`until`	query	`string \| null`
`cursor`	query	`string \| null`
`limit`	query	`integer`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/deliveries' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhooks/WEBHOOK_ID/deliveries",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhooks/WEBHOOK_ID/deliveries");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhooks/{webhook_id}/deliveries/{delivery_id}`

Get Delivery Auth: X-API-Key

One delivery with every attempt, the signed payload and the last response body.

Parameters of GET /v1/webhooks/{webhook_id}/deliveries/{delivery_id}
Parameter	In	Type	Description
`webhook_id` required	path	`string`
`delivery_id` required	path	`string`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend`

Resend Delivery Idempotency-Key Auth: X-API-Key

Queue this delivery's event again to the endpoint. Returns the new delivery (202).

Parameters of POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend
Parameter	In	Type
`webhook_id` required	path	`string`
`delivery_id` required	path	`string`
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

202 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID/resend' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID/resend",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhooks/WEBHOOK_ID/deliveries/DELIVERY_ID/resend", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhooks/{webhook_id}/disable`

Disable Endpoint Idempotency-Key Auth: X-API-Key

Stop deliveries to an endpoint; unfinished deliveries are closed as failed.

Parameters of POST /v1/webhooks/{webhook_id}/disable
Parameter	In	Type
`webhook_id` required	path	`string`
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/disable' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhooks/WEBHOOK_ID/disable",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhooks/WEBHOOK_ID/disable", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhooks/{webhook_id}/enable`

Enable Endpoint Idempotency-Key Auth: X-API-Key

Re-enable an endpoint (after an automatic disable, or your own).

Parameters of POST /v1/webhooks/{webhook_id}/enable
Parameter	In	Type
`webhook_id` required	path	`string`
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/enable' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhooks/WEBHOOK_ID/enable",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhooks/WEBHOOK_ID/enable", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhooks/{webhook_id}/reveal-secret`

Reveal Secret Auth: X-API-Key

The current signing secret (and the previous one during a rotation overlap).

Parameters of POST /v1/webhooks/{webhook_id}/reveal-secret
Parameter	In	Type
`webhook_id` required	path	`string`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/reveal-secret' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhooks/WEBHOOK_ID/reveal-secret",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhooks/WEBHOOK_ID/reveal-secret", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/v1/webhooks/{webhook_id}/rotate-secret`

Rotate Secret Idempotency-Key Auth: X-API-Key

New signing secret; the old one stays valid for overlapHours (default 24).

Parameters of POST /v1/webhooks/{webhook_id}/rotate-secret
Parameter	In	Type
`webhook_id` required	path	`string`
`Idempotency-Key`	header	`string \| null`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Request body RotateSecret | null

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/rotate-secret' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Idempotency-Key: my-request-1' \
  -H 'X-Reason: why you are doing this' \
  -H 'Content-Type: application/json' \
  -d '{"overlapHours":24}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/v1/webhooks/WEBHOOK_ID/rotate-secret",
        json={"overlapHours": 24},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/v1/webhooks/WEBHOOK_ID/rotate-secret", {
  body: {"overlapHours":24},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/webhooks/{webhook_id}/settings`

Endpoint Settings Auth: X-API-Key

Endpoint status, failure streak, event filter and secret-rotation state.

Parameters of GET /v1/webhooks/{webhook_id}/settings
Parameter	In	Type	Description
`webhook_id` required	path	`string`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/webhooks/WEBHOOK_ID/settings' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/webhooks/WEBHOOK_ID/settings",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/webhooks/WEBHOOK_ID/settings");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST /v1/events/{event_id}/resend

GET /v1/webhook-event-types

POST /v1/webhook-events/trigger

POST /v1/webhook-listeners

GET /v1/webhook-listeners/{listener_id}/events

GET /v1/webhooks

POST /v1/webhooks

GET /v1/webhooks/{webhook_id}

PATCH /v1/webhooks/{webhook_id}

DELETE /v1/webhooks/{webhook_id}

GET /v1/webhooks/{webhook_id}/deliveries

GET /v1/webhooks/{webhook_id}/deliveries/{delivery_id}

POST /v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend

POST /v1/webhooks/{webhook_id}/disable

POST /v1/webhooks/{webhook_id}/enable

POST /v1/webhooks/{webhook_id}/reveal-secret

POST /v1/webhooks/{webhook_id}/rotate-secret

GET /v1/webhooks/{webhook_id}/settings

POST `/v1/events/{event_id}/resend`

GET `/v1/webhook-event-types`

POST `/v1/webhook-events/trigger`

POST `/v1/webhook-listeners`

GET `/v1/webhook-listeners/{listener_id}/events`

GET `/v1/webhooks`

POST `/v1/webhooks`

GET `/v1/webhooks/{webhook_id}`

PATCH `/v1/webhooks/{webhook_id}`

DELETE `/v1/webhooks/{webhook_id}`

GET `/v1/webhooks/{webhook_id}/deliveries`

GET `/v1/webhooks/{webhook_id}/deliveries/{delivery_id}`

POST `/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/resend`

POST `/v1/webhooks/{webhook_id}/disable`

POST `/v1/webhooks/{webhook_id}/enable`

POST `/v1/webhooks/{webhook_id}/reveal-secret`

POST `/v1/webhooks/{webhook_id}/rotate-secret`

GET `/v1/webhooks/{webhook_id}/settings`