All methods

Every SDK method, the endpoint it calls and what it returns.

Every method of the @swarmhit/swarmhit-sdk package, grouped as they appear on the client. Each method links to its endpoint in the API Reference, which documents every parameter and field. Arguments follow the usual order: the path ids, then one params object, then the request options. The list shows params? when everything in params is optional.

In the Returns column, you can iterate a page of result with for await: see Lists and pagination. Retry-safe methods send an idempotency key, so a retry never repeats the action: see Never twice. The package exports every type named here: import type { Campaign } from '@swarmhit/swarmhit-sdk'.

swarmhit

MethodWhat it doesReturns
swarmhit.info()
GET /
API infoGetApiInfoResponse
swarmhit.health()
GET /health
Service healthHealth

swarmhit.stats

MethodWhat it doesReturns
swarmhit.stats.get()
GET /stats
Workspace statsStats

swarmhit.campaigns

MethodWhat it doesReturns
swarmhit.campaigns.list(params?)
GET /campaigns
List campaignspage of Campaign
swarmhit.campaigns.create(params?)
POST /campaigns
Create a campaignCampaignDetail
swarmhit.campaigns.get(campaignId)
GET /campaigns/{id}
Get a campaignCampaignDetail
swarmhit.campaigns.update(campaignId, params)
PATCH /campaigns/{id}
Update a campaignCampaignDetail
swarmhit.campaigns.delete(campaignId)
DELETE /campaigns/{id}
Delete a campaignDeleteCampaignResponse
swarmhit.campaigns.duplicate(campaignId)
POST /campaigns/{id}/duplicate
Duplicate a campaignCampaignDetail
swarmhit.campaigns.updateStep(campaignId, stepId, params)
PATCH /campaigns/{id}/sequence/{stepId}
Update one campaign sequence stepCampaignDetail
swarmhit.campaigns.rebalanceSender(campaignId, accountId)
POST /campaigns/{id}/senders/{accountId}/rebalance
Rebalance a sender's leadsRebalanceCampaignSenderResponse

swarmhit.campaigns.leads

MethodWhat it doesReturns
swarmhit.campaigns.leads.list(campaignId, params?)
GET /campaigns/{id}/leads
List the leads in a campaignpage of LeadInCampaign
swarmhit.campaigns.leads.add(campaignId, params)
POST /campaigns/{id}/leads
Add leads to a campaignAddLeadsToCampaignResponse
swarmhit.campaigns.leads.get(campaignId, leadId)
GET /campaigns/{id}/leads/{leadId}
A lead's progress in a campaignLeadInCampaignDetail
swarmhit.campaigns.leads.setInterest(campaignId, leadId, params)
PATCH /campaigns/{id}/leads/{leadId}
Set a lead's interest in a campaignLeadInCampaignDetail
swarmhit.campaigns.leads.remove(campaignId, leadId)
DELETE /campaigns/{id}/leads/{leadId}
Remove a lead from a campaignRemoveLeadFromCampaignResponse
swarmhit.campaigns.leads.pause(campaignId, leadId)
POST /campaigns/{id}/leads/{leadId}/pause
Pause a lead in a campaignLeadInCampaign
swarmhit.campaigns.leads.resume(campaignId, leadId)
POST /campaigns/{id}/leads/{leadId}/resume
Resume a paused lead in a campaignLeadInCampaign
swarmhit.campaigns.leads.retry(campaignId, leadId)
POST /campaigns/{id}/leads/{leadId}/retry
Retry a lead in a campaignLeadInCampaign
swarmhit.campaigns.leads.stop(campaignId, leadId)
POST /campaigns/{id}/leads/{leadId}/stop
Stop a lead in a campaign for goodLeadInCampaign

swarmhit.leads

MethodWhat it doesReturns
swarmhit.leads.list(params?)
GET /leads
List leadspage of Lead
swarmhit.leads.get(leadId)
GET /leads/{id}
Get a leadLead
swarmhit.leads.update(leadId, params)
PATCH /leads/{id}
Update a leadLead
swarmhit.leads.delete(leadId)
DELETE /leads/{id}
Delete a leadDeleteLeadResponse
swarmhit.leads.getActivity(leadId)
GET /leads/{id}/activity
Get a lead's activityGetLeadActivityResponse
swarmhit.leads.enrich(leadId, params?)
POST /leads/{id}/enrich
Find a lead's email or phoneLead
swarmhit.leads.enrichMany(params)
POST /leads/enrich
Find emails or phones for many leadsEnrichLeadsResponse

swarmhit.lists

MethodWhat it doesReturns
swarmhit.lists.list(params?)
GET /lists
List lead listspage of List
swarmhit.lists.create(params?)
POST /lists
Create a lead listList
swarmhit.lists.get(listId)
GET /lists/{id}
Get a lead listList
swarmhit.lists.update(listId, params)
PATCH /lists/{id}
Rename a lead listList
swarmhit.lists.delete(listId)
DELETE /lists/{id}
Delete a lead listDeleteListResponse

swarmhit.lists.leads

MethodWhat it doesReturns
swarmhit.lists.leads.list(listId, params?)
GET /lists/{id}/leads
List a list's leadspage of Lead
swarmhit.lists.leads.add(listId, params)
POST /lists/{id}/leads
Add leads to a listAddListLeadsResponse
swarmhit.lists.leads.remove(listId, leadId)
DELETE /lists/{id}/leads/{leadId}
Remove a lead from a listRemoveListLeadResponse

swarmhit.leadImports

MethodWhat it doesReturns
swarmhit.leadImports.create(params)
POST /lead-imports
Start a LinkedIn search importLeadImport
swarmhit.leadImports.list(params?)
GET /lead-imports
List lead importspage of LeadImport
swarmhit.leadImports.get(leadImportId)
GET /lead-imports/{id}
Get a lead importLeadImport
swarmhit.leadImports.delete(leadImportId)
DELETE /lead-imports/{id}
Delete a terminal lead importDeleteLeadImportResponse
swarmhit.leadImports.cancel(leadImportId)
POST /lead-imports/{id}/cancel
Cancel a running lead importLeadImport
swarmhit.leadImports.resume(leadImportId)
POST /lead-imports/{id}/resume
Resume a paused or failed lead importLeadImport

swarmhit.database

MethodWhat it doesReturns
swarmhit.database.suggestions(params)
POST /database/suggestions
List valid filter valuesDatabaseSuggestionsResponse
swarmhit.database.capabilities()
GET /database/capabilities
List supported filtersDatabaseCapabilitiesResponse

swarmhit.database.people

MethodWhat it doesReturns
swarmhit.database.people.search(params)
POST /database/people/search
Search people in the databasepage of DbPerson
swarmhit.database.people.enrich(params)
POST /database/people/enrich
Enrich a personDbPersonDetail
swarmhit.database.people.findEmail(params)
POST /database/people/find-email
Find a person's emailFindEmailDatabaseResponse
swarmhit.database.people.findPhone(params)
POST /database/people/find-phone
Find a person's phoneFindPhoneDatabaseResponse

swarmhit.database.companies

MethodWhat it doesReturns
swarmhit.database.companies.search(params)
POST /database/companies/search
Search companies in the databasepage of DbCompany
swarmhit.database.companies.enrich(params)
POST /database/companies/enrich
Enrich a companyDbCompany

swarmhit.inbox

MethodWhat it doesReturns
swarmhit.inbox.getCounts(params?)
GET /inbox/counts
Unread messages and favouritesGetInboxCountsResponse
swarmhit.inbox.sync(params)
POST /inbox/sync
Pull a sender's recent chats from LinkedInSyncInboxChatsResponse

swarmhit.inbox.chats

MethodWhat it doesReturns
swarmhit.inbox.chats.list(params?)
GET /inbox/chats
List inbox chatspage of Chat
swarmhit.inbox.chats.get(chatId)
GET /inbox/chats/{id}
Get an inbox chatChat
swarmhit.inbox.chats.markRead(chatId)
POST /inbox/chats/{id}/read
Mark a chat readMarkChatReadResponse
swarmhit.inbox.chats.setFavorite(chatId, params)
POST /inbox/chats/{id}/favorite
Star or unstar a chatChat
swarmhit.inbox.chats.sync(chatId, params?)
POST /inbox/chats/{id}/sync
Pull a chat's latest messages from LinkedInSyncChatMessagesResponse

swarmhit.inbox.chats.messages

MethodWhat it doesReturns
swarmhit.inbox.chats.messages.list(chatId, params?)
GET /inbox/chats/{id}/messages
List messages in a chatpage of Message
swarmhit.inbox.chats.messages.send(chatId, params)
POST /inbox/chats/{id}/messages
Send a message in a chat Retry-safe.SendChatMessageResponse

swarmhit.accounts

MethodWhat it doesReturns
swarmhit.accounts.list(params?)
GET /accounts
List sender accountspage of ListAccountsItem
swarmhit.accounts.connect(params)
POST /accounts
Connect a senderConnectSenderResponse
swarmhit.accounts.get(accountId)
GET /accounts/{id}
Get a sender accountAccount
swarmhit.accounts.update(accountId, params)
PATCH /accounts/{id}
Rename a senderAccount
swarmhit.accounts.disconnect(accountId, params?)
DELETE /accounts/{id}
Disconnect a senderDisconnectSenderResponse
swarmhit.accounts.restore(accountId, params?)
POST /accounts/{id}/restore
Restore an archived accountAccount
swarmhit.accounts.sync(accountId)
POST /accounts/{id}/sync
Sync account informationAccount
swarmhit.accounts.reconnect(accountId, params?)
POST /accounts/{id}/reconnect
Reconnect a sender accountReconnectAccountResponse
swarmhit.accounts.pause(accountId)
POST /accounts/{id}/pause
Pause a senderAccount
swarmhit.accounts.resume(accountId)
POST /accounts/{id}/resume
Resume a paused senderAccount
swarmhit.accounts.getSsi(accountId, params?)
GET /accounts/{id}/ssi
Social Selling IndexAccountSsi
swarmhit.accounts.getStats(accountId, params?)
GET /accounts/{id}/stats
Sender performanceAccountStats
swarmhit.accounts.createLiveView(accountId)
POST /accounts/{id}/live-view
Open a live view of the sign-in browserCreateAccountLiveViewResponse
swarmhit.accounts.pickNewIp(accountId)
POST /accounts/{id}/pick-new-ip
Move a stopped sender onto a new IPAccount

swarmhit.accounts.checkpoint

MethodWhat it doesReturns
swarmhit.accounts.checkpoint.get(accountId)
GET /accounts/{id}/checkpoint
Get the pending sign-in challengeGetAccountCheckpointResponse
swarmhit.accounts.checkpoint.solve(accountId, params)
POST /accounts/{id}/checkpoint
Answer the pending sign-in challengeSolveAccountCheckpointResponse
swarmhit.accounts.checkpoint.resend(accountId)
POST /accounts/{id}/checkpoint/resend
Re-send the pending sign-in challengeResendAccountCheckpointResponse

swarmhit.accounts.limits

MethodWhat it doesReturns
swarmhit.accounts.limits.get(accountId)
GET /accounts/{id}/limits
Get a sender's limitsAccountLimits
swarmhit.accounts.limits.update(accountId, params)
PATCH /accounts/{id}/limits
Change a sender's limitsAccountLimits

swarmhit.accounts.warmup

MethodWhat it doesReturns
swarmhit.accounts.warmup.get()
GET /accounts/warmup
Get the LinkedIn warm-up settingsAccountWarmupPolicy
swarmhit.accounts.warmup.update(params)
PATCH /accounts/warmup
Change the LinkedIn warm-up settingsAccountWarmupPolicy
MethodWhat it doesReturns
swarmhit.accounts.hostedLinks.create(params)
POST /accounts/hosted-link
Create a hosted connect linkHostedLink
swarmhit.accounts.hostedLinks.get(hostedLinkId)
GET /accounts/hosted-link/{id}
Get a hosted connect linkHostedLink

swarmhit.accounts.connections

MethodWhat it doesReturns
swarmhit.accounts.connections.send(accountId, params)
POST /accounts/{id}/connections
Send a connection request Retry-safe.OutreachAction
swarmhit.accounts.connections.get(accountId, identifier)
GET /accounts/{id}/connections/{identifier}
Check connection statusConnection
swarmhit.accounts.connections.withdraw(accountId, identifier)
DELETE /accounts/{id}/connections/{identifier}
Withdraw a connection requestWithdrawConnectionRequestResponse

swarmhit.accounts.messages

MethodWhat it doesReturns
swarmhit.accounts.messages.send(accountId, params)
POST /accounts/{id}/messages
Message a connection Retry-safe.OutreachAction

swarmhit.accounts.inmails

MethodWhat it doesReturns
swarmhit.accounts.inmails.send(accountId, params)
POST /accounts/{id}/inmails
Send an InMail Retry-safe.OutreachAction

swarmhit.accounts.profiles

MethodWhat it doesReturns
swarmhit.accounts.profiles.get(accountId, identifier)
GET /accounts/{id}/profiles/{identifier}
Look up a profileProfile
swarmhit.accounts.profiles.visit(accountId, params)
POST /accounts/{id}/profile-views
Visit a profile Retry-safe.OutreachAction
swarmhit.accounts.profiles.follow(accountId, params)
POST /accounts/{id}/follows
Follow a lead Retry-safe.OutreachAction

swarmhit.accounts.posts

MethodWhat it doesReturns
swarmhit.accounts.posts.like(accountId, params)
POST /accounts/{id}/post-likes
Like a post Retry-safe.OutreachAction
swarmhit.accounts.posts.comment(accountId, params)
POST /accounts/{id}/post-comments
Comment on a post Retry-safe.OutreachAction
swarmhit.accounts.posts.listComments(accountId, params)
GET /accounts/{id}/post-comments
List a post's commentspage of PostComment

swarmhit.accounts.actions

MethodWhat it doesReturns
swarmhit.accounts.actions.list(accountId, params?)
GET /accounts/{id}/actions
List direct actionspage of OutreachAction

swarmhit.emailAccounts

MethodWhat it doesReturns
swarmhit.emailAccounts.list(params?)
GET /email-accounts
List mailboxespage of MailboxAccount
swarmhit.emailAccounts.get(emailAccountId)
GET /email-accounts/{id}
Get a mailboxMailboxAccount
swarmhit.emailAccounts.delete(emailAccountId)
DELETE /email-accounts/{id}
Remove a mailboxRemoveEmailAccountResponse
swarmhit.emailAccounts.pause(emailAccountId)
POST /email-accounts/{id}/pause
Pause a mailboxMailboxAccount
swarmhit.emailAccounts.resume(emailAccountId)
POST /email-accounts/{id}/resume
Resume a paused mailboxMailboxAccount
swarmhit.emailAccounts.checkDns(emailAccountId)
POST /email-accounts/{id}/check-dns
Re-check a mailbox's domainMailboxAccount
swarmhit.emailAccounts.testDeliverability(emailAccountId)
POST /email-accounts/{id}/deliverability-test
Run a deliverability testMailboxAccount
swarmhit.emailAccounts.getStats(emailAccountId, params?)
GET /email-accounts/{id}/stats
Mailbox performanceMailboxStats
swarmhit.emailAccounts.cancelManaged(emailAccountId, params?)
POST /email-accounts/{id}/cancel-managed
Cancel a bought mailboxCancelManagedEmailAccountResponse
swarmhit.emailAccounts.setPicture(emailAccountId, params)
POST /email-accounts/{id}/picture
Set a bought mailbox's pictureMailboxAccount

swarmhit.emailAccounts.emails

MethodWhat it doesReturns
swarmhit.emailAccounts.emails.send(emailAccountId, params)
POST /email-accounts/{id}/emails
Send an email Retry-safe.DirectEmail
swarmhit.emailAccounts.emails.list(emailAccountId, params?)
GET /email-accounts/{id}/emails
List emails sent through the APIpage of DirectEmail
MethodWhat it doesReturns
swarmhit.emailAccounts.hostedLinks.create(params)
POST /email-accounts/hosted-link
Create a hosted connect link for a mailboxHostedLink
swarmhit.emailAccounts.hostedLinks.get(hostedLinkId)
GET /email-accounts/hosted-link/{id}
Get a mailbox hosted connect linkHostedLink

swarmhit.emailAccounts.warmup

MethodWhat it doesReturns
swarmhit.emailAccounts.warmup.get(emailAccountId)
GET /email-accounts/{id}/warmup
Get a mailbox's warmupWarmupState
swarmhit.emailAccounts.warmup.update(emailAccountId, params)
PATCH /email-accounts/{id}/warmup
Change the warmup strategyWarmupState
swarmhit.emailAccounts.warmup.start(emailAccountId, params?)
POST /email-accounts/{id}/warmup/start
Start warmupWarmupState
swarmhit.emailAccounts.warmup.pause(emailAccountId)
POST /email-accounts/{id}/warmup/pause
Pause warmupWarmupState
swarmhit.emailAccounts.warmup.resume(emailAccountId)
POST /email-accounts/{id}/warmup/resume
Resume warmupWarmupState
swarmhit.emailAccounts.warmup.stop(emailAccountId)
POST /email-accounts/{id}/warmup/stop
Stop warmupWarmupState
swarmhit.emailAccounts.warmup.overrideHold(emailAccountId, params)
POST /email-accounts/{id}/warmup/hold-override
Send before warmup is doneWarmupState
swarmhit.emailAccounts.warmup.getStats(emailAccountId, params?)
GET /email-accounts/{id}/warmup/stats
Warmup daily seriesGetEmailAccountWarmupStatsResponse

swarmhit.domains

MethodWhat it doesReturns
swarmhit.domains.search(params)
GET /domains/search
Search domains to buySearchDomainsResponse

swarmhit.managedDomains

MethodWhat it doesReturns
swarmhit.managedDomains.list(params?)
GET /managed-domains
List the domains you boughtListManagedDomainsResponse

swarmhit.mailboxBilling

MethodWhat it doesReturns
swarmhit.mailboxBilling.get()
GET /mailbox-billing
What you pay for bought mailboxesMailboxBilling

swarmhit.mailboxOrders

MethodWhat it doesReturns
swarmhit.mailboxOrders.quote(params)
POST /mailbox-orders/quote
Price an orderMailboxOrderQuote
swarmhit.mailboxOrders.list(params?)
GET /mailbox-orders
List mailbox orderspage of MailboxOrder
swarmhit.mailboxOrders.create(params)
POST /mailbox-orders
Buy domains and mailboxes Retry-safe.MailboxOrder
swarmhit.mailboxOrders.get(mailboxOrderId, params?)
GET /mailbox-orders/{id}
Get a mailbox orderMailboxOrder

swarmhit.callTasks

MethodWhat it doesReturns
swarmhit.callTasks.list(params?)
GET /call-tasks
List call taskspage of CallTask
swarmhit.callTasks.get(callTaskId)
GET /call-tasks/{id}
Get a call taskCallTask
swarmhit.callTasks.complete(callTaskId, params)
POST /call-tasks/{id}/complete
Log a callCallTask
swarmhit.callTasks.skip(callTaskId)
POST /call-tasks/{id}/skip
Skip a callCallTask
swarmhit.callTasks.stop(callTaskId, params?)
POST /call-tasks/{id}/stop
Stop the lead's sequenceCallTask

swarmhit.whatsappAccounts

MethodWhat it doesReturns
swarmhit.whatsappAccounts.list(params?)
GET /whatsapp-accounts
List WhatsApp numberspage of WhatsappAccount
swarmhit.whatsappAccounts.link(params)
POST /whatsapp-accounts
Link a WhatsApp numberLinkWhatsappAccountResponse
swarmhit.whatsappAccounts.get(whatsappAccountId)
GET /whatsapp-accounts/{id}
Get a WhatsApp numberWhatsappAccount
swarmhit.whatsappAccounts.update(whatsappAccountId, params)
PATCH /whatsapp-accounts/{id}
Change a number's name, caps or warm-upWhatsappAccount
swarmhit.whatsappAccounts.delete(whatsappAccountId)
DELETE /whatsapp-accounts/{id}
Remove a WhatsApp numberRemoveWhatsappAccountResponse
swarmhit.whatsappAccounts.getLink(whatsappAccountId)
GET /whatsapp-accounts/{id}/link
Follow a linkWhatsappLinkState
swarmhit.whatsappAccounts.relink(whatsappAccountId, params?)
POST /whatsapp-accounts/{id}/relink
Scan againRelinkWhatsappAccountResponse
swarmhit.whatsappAccounts.cancelLink(whatsappAccountId)
POST /whatsapp-accounts/{id}/cancel-link
Cancel a linkCancelWhatsappLinkResponse
swarmhit.whatsappAccounts.pause(whatsappAccountId)
POST /whatsapp-accounts/{id}/pause
Pause a WhatsApp numberWhatsappAccount
swarmhit.whatsappAccounts.resume(whatsappAccountId)
POST /whatsapp-accounts/{id}/resume
Resume a WhatsApp numberWhatsappAccount
swarmhit.whatsappAccounts.getStats(whatsappAccountId)
GET /whatsapp-accounts/{id}/stats
WhatsApp number performance and healthWhatsappStats

swarmhit.pendingComments

MethodWhat it doesReturns
swarmhit.pendingComments.list(params?)
GET /pending-comments
List AI comment draftspage of PendingComment
swarmhit.pendingComments.get(pendingCommentId)
GET /pending-comments/{id}
Get a comment draftPendingComment
swarmhit.pendingComments.update(pendingCommentId, params)
PATCH /pending-comments/{id}
Edit a comment draftPendingComment
swarmhit.pendingComments.approve(pendingCommentId, params?)
POST /pending-comments/{id}/approve
Approve a comment draftPendingComment
swarmhit.pendingComments.reject(pendingCommentId)
POST /pending-comments/{id}/reject
Reject a comment draftPendingComment
swarmhit.pendingComments.regenerate(pendingCommentId, params?)
POST /pending-comments/{id}/regenerate
Re-draft a commentPendingComment

swarmhit.pendingVoiceNotes

MethodWhat it doesReturns
swarmhit.pendingVoiceNotes.list(params?)
GET /pending-voice-notes
List AI voice notes awaiting reviewpage of PendingVoiceNote
swarmhit.pendingVoiceNotes.get(pendingVoiceNoteId)
GET /pending-voice-notes/{id}
Get a voice note awaiting reviewPendingVoiceNote
swarmhit.pendingVoiceNotes.approve(pendingVoiceNoteId)
POST /pending-voice-notes/{id}/approve
Approve a voice notePendingVoiceNote
swarmhit.pendingVoiceNotes.reject(pendingVoiceNoteId)
POST /pending-voice-notes/{id}/reject
Reject a voice notePendingVoiceNote
swarmhit.pendingVoiceNotes.regenerate(pendingVoiceNoteId, params?)
POST /pending-voice-notes/{id}/regenerate
Re-record a voice notePendingVoiceNote

swarmhit.workspaces

MethodWhat it doesReturns
swarmhit.workspaces.list()
GET /workspaces
List workspacesOrganizationWorkspaces
swarmhit.workspaces.create(params)
POST /workspaces
Create a workspaceOrganizationWorkspaceDetail
swarmhit.workspaces.get(workspaceId)
GET /workspaces/{id}
Get a workspaceOrganizationWorkspaceDetail
swarmhit.workspaces.update(workspaceId, params)
PATCH /workspaces/{id}
Update a workspaceOrganizationWorkspaceDetail
swarmhit.workspaces.delete(workspaceId)
DELETE /workspaces/{id}
Delete a workspaceDeleteWorkspaceResponse

swarmhit.workspaces.members

MethodWhat it doesReturns
swarmhit.workspaces.members.list(workspaceId)
GET /workspaces/{id}/members
List a workspace's membersListWorkspaceMembersResponse
swarmhit.workspaces.members.invite(workspaceId, params)
POST /workspaces/{id}/members
Invite a member to a workspaceInviteWorkspaceMemberResponse
swarmhit.workspaces.members.update(workspaceId, memberId, params)
PATCH /workspaces/{id}/members/{memberId}
Update a workspace member's roleUpdateWorkspaceMemberResponse
swarmhit.workspaces.members.remove(workspaceId, memberId, params?)
DELETE /workspaces/{id}/members/{memberId}
Remove a workspace member or revoke an inviteRemoveWorkspaceMemberResponse

swarmhit.webhooks

MethodWhat it doesReturns
swarmhit.webhooks.list(params?)
GET /webhooks
List webhook endpointspage of Webhook
swarmhit.webhooks.create(params)
POST /webhooks
Create a webhook endpointWebhook
swarmhit.webhooks.get(webhookId)
GET /webhooks/{id}
Get a webhook endpointWebhook
swarmhit.webhooks.update(webhookId, params)
PATCH /webhooks/{id}
Update a webhook endpointWebhook
swarmhit.webhooks.delete(webhookId)
DELETE /webhooks/{id}
Delete a webhook endpointDeleteWebhookResponse
swarmhit.webhooks.test(webhookId)
POST /webhooks/{id}/test
Send a test deliveryTestWebhookResponse
swarmhit.webhooks.listDeliveries(webhookId, params?)
GET /webhooks/{id}/deliveries
List recent deliveriespage of WebhookDelivery

swarmhit.webhooks.deliveries

MethodWhat it doesReturns
swarmhit.webhooks.deliveries.list(params?)
GET /webhooks/deliveries
List the delivery logpage of WebhookDelivery
swarmhit.webhooks.deliveries.resend(deliveryId)
POST /webhooks/deliveries/{id}/resend
Replay a deliveryWebhookDelivery

swarmhit.countries

MethodWhat it doesReturns
swarmhit.countries.list()
GET /countries
List countriesListCountriesResponse

swarmhit.timezones

MethodWhat it doesReturns
swarmhit.timezones.list()
GET /timezones
List timezonesListTimezonesResponse

swarmhit.voices

MethodWhat it doesReturns
swarmhit.voices.list()
GET /voices
List voicesListVoicesResponse

Webhook events

swarmhit.webhooks.unwrap() returns one of these, typed by its event: message.received, message.sent, connection.accepted, lead.status_changed, campaign.finished, lead.imported, lead.enriched, comment.pending, voice_note.pending, call_task.pending, account.connected, account.connection_failed, account.status_changed, account.checkpoint_required, email.sent, email.received, email.bounced, email.opened, email.clicked, email.unsubscribed, account.paused, account.resumed, account.archived, account.restored, account.deleted, webhook.test, account.warmup_completed, whatsapp.sent, whatsapp.received, whatsapp.read, mailbox_order.completed, mailbox_order.failed, mailbox_billing.payment_failed, mailbox_billing.payment_recovered, warmup.status_changed, warmup.ready, warmup.health_changed.