Create method 📢 Webhooks

Enrolls the user to receive event notifications via webhooks.

Usage

modular.ts

import { MailChannelsClient, Webhooks } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const webhooks = new Webhooks(mailchannels)

const { success, error } = await webhooks.create("https://example.com/api/webhooks/mailchannels")

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { success, error } = await mailchannels.webhooks.create("https://example.com/api/webhooks/mailchannels")

Params

• endpoint string required: The URL to receive event notifications. Must be no longer than 8000 characters.

Response

• success boolean guaranteed: Whether the operation was successful.
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request. This field is intended for diagnostic use only and should not be relied upon.
  • type string guaranteed: A string identifier for the type of error. This field is intended for diagnostic use only and should not be relied upon.

Type declarations

Signature

async function create (endpoint: string): Promise<SuccessResponse>

Response type declarations

interface ErrorResponse {
  message: string;
  statusCode: number | null;
  type: ErrorType;
}

interface SuccessResponse {
  success: boolean;
  error: ErrorResponse | null;
}

Source

Source • Playground • Docs • Tests