Home/Tools/@tpmjs/tools-postmark

createWebhook

@tpmjs/tools-postmark

Create a new webhook.

Official
ops
v0.2.1
MIT

Interactive Playground

Test @tpmjs/tools-postmark (createWebhook) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-postmark
pnpm add @tpmjs/tools-postmark
yarn add @tpmjs/tools-postmark
bun add @tpmjs/tools-postmark
deno add npm:@tpmjs/tools-postmark

2. Import the tool

import { createWebhook } from '@tpmjs/tools-postmark';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { createWebhook } from '@tpmjs/tools-postmark';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { createWebhook },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Signature

(Url: string, HttpAuth?: { Password: string; Username: string }, Triggers?: { Open: { Enabled: boolean; PostFirstOpenOnly: boolean }; Click: { Enabled: boolean }; Bounce: { Enabled: boolean; IncludeContent: boolean }; Delivery: { Enabled: boolean }; SpamComplaint: { Enabled: boolean; IncludeContent: boolean } }, HttpHeaders?: { Name: string; Value: string }[], MessageStream?: string) => Promise<unknown>

Tags

agent
create
email
new
ops
postmark
smtp
tpmjs
transactional
webhook

Parameters

Available configuration options

Auto-extracted
Url
Required
Type: string

Webhook endpoint URL.

MessageStream
Optional
Type: string

Message stream to listen on.

HttpAuth
Optional
Type: object

HTTP basic auth credentials.

HttpHeaders
Optional
Type: array

Custom HTTP headers sent with webhook.

Triggers
Optional
Type: object

Event triggers to enable.

Schema extracted: 3/1/2026, 4:29:11 AM

README

ERROR: No README data found!

Statistics

Downloads/month

178

GitHub Stars

14

Quality Score

89%

Bundle Size

NPM Keywords

tpmjs
postmark
email
transactional
smtp
agent

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai