instantly-webhooks-events

Instantly Webhook Operations

Overview

Build a receiver for documented Instantly event types without assuming an unpublished signature or retry contract. Record assumptions, evidence, approval state, and rollback ownership so another operator can reproduce the result.

Prerequisites

• The target repository, Instantly workspace, environment, and accountable owner
• Current security, privacy, compliance, capacity, and change-control requirements
• An approved API v2 key only when a bounded live verification is necessary

Tool Discipline

Use Read, Glob, and Grep to inspect code, configuration, and evidence. Use WebFetch only for current first-party Instantly documentation and package metadata. Use Write or Edit only when implementation was requested and exact target files are known; never write credentials, lead data, email content, or unrestricted environment output.

Current Contract

• Events include workspace, campaign, timestamp, event_type, and optional lead/email/reply content.
• Custom labels may arrive as event_type values.
• The API supports list, create, patch, delete, test, resume, event-type discovery, and delivery-event observability.

Authentication

Use an API v2 key as Authorization: Bearer <key> against https://api.instantly.ai/api/v2. Grant only the endpoint-specific scopes needed, inject the key from an approved server-side secret manager, and never print, persist, commit, or place it in a URL. Treat key creation, rotation, revocation, member changes, workspace delegation, and production access as owner-approved actions.

Instructions

1. Fetch the live event-type list and select only required events.
2. Review the HTTPS destination, data classification, retention, and receiver owner.
3. Create the webhook with the exact documented fields and least-privilege scope.
4. Validate schema, workspace identity, timestamp bounds, payload size, and event-specific optional fields.
5. Deduplicate using a receiver-owned stable fingerprint and process asynchronously.
6. Use test, delivery-event aggregates, and resume only with explicit change approval.

Approval Boundaries

Do not create, rotate, reveal, or revoke keys; invite or remove members; delegate across workspaces; connect sending accounts; create or activate campaigns; import or delete leads; change suppression or retention; register, patch, resume, or delete webhooks; alter plans or paid capacity; transmit diagnostics; or perform another production mutation without explicit approval from the accountable owner. Keep diagnosis read-only unless implementation was requested.

Output

Return the workspace-safe scope, files and contracts inspected, exact API v2 routes and required scopes, evidence collected, validation result, sensitive fields redacted, remaining risk, accountable owner, approval state, and rollback or next action.

Error Handling

Examples

Use a compact handoff that makes scope, mutation authority, and evidence reviewable.

Input:

events=email_bounced,reply_received; receiver=https://example.invalid/hook

Expected handoff:

registration=planned; signature=not-assumed; approval=required

Resources

• Skill-specific official documentation
• Instantly API v2 documentation
• Instantly API v2 OpenAPI document