[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12},"actionData","errors","root",{"_355":356,"_357":358,"_359":-5,"_360":361,"_362":363,"_364":365,"_366":367,"_240":368,"_369":370,"_252":-7,"_254":-7,"_371":372,"_373":243,"_374":375,"_376":375,"_377":-7,"_378":379,"_380":381,"_382":383,"_384":385,"_259":260,"_386":-7,"_387":33,"_388":45},"routes/_docs/_index",{"_240":241,"_242":243,"_244":245,"_246":247,"_248":249,"_250":251,"_252":-7,"_253":-7,"_254":-7,"_38":39,"_255":-7,"_256":247,"_257":-7,"_258":45,"_259":260,"_261":262},"routes/_docs.$productname/_index",{"_51":52,"_53":54,"_55":-7,"_56":57,"_58":59,"_60":33},"routes/_docs.$productname.$/_index",{"_13":14,"_15":16,"_17":18,"_19":20,"_21":-7,"_22":-7,"_23":24,"_25":26,"_27":-7,"_28":29,"_30":31,"_32":33,"_34":35},"type","html","content","

Webhooks are currently triggered at the organization-wide level, meaning events for all domains your organization has set up with Paubox will trigger a webhook notification.

You can setup webhooks in the Paubox Dashboard.

Webhook fields

URL: You will need to provide an HTTPS URL which you own, to which you would like your webhook payload to be sent.
Event: The events notifications to which you would like to subscribe

Available events

Event Name	Event Name Key Value	Trigger
Delivered	api_mail_log_delivered	When message is delivered
Temporary Failure	api_mail_log_temporary_failure	On soft bounce of message
Permanent Failure	api_mail_log_permanent_failure	On hard bounce of message
Opened	api_mail_log_opened	On opening of message

Payloads

Every Webhook notification will include an event_name key and a payload key. The type of payload you should expect is dependent on the data model that is triggering the webhook event.

The most common type of payload is the API Mail Log payload, which is structured as follows:

{\n \"event_name\": \"api_mail_log_permanent_failure\",\n \"payload\": {\n   \"id\": 5555555555,\n   \"subject\": \"Hello from the Paubox Email API\",\n   \"header_message_id\": \"<XXX430aa-9b7c-42d5-9614-2e38f5a3f71f@XXXXXXXXX.com>\",\n   \"source_tracking_id\": \"XXXef39e-b376-4a44-b2b9-85bdb406dXXX\",\n   \"outbound_queue_id\": \"XXXyFY0y3Yz2XXX\",\n   \"time\": \"2022-04-18T20:27:25.379Z\",\n   \"from\": \"XXXXXX@XXXXXXX.com\",\n   \"to\": \"XXXXXXX@XXXXXXX.com\",\n   \"custom_headers\": {\n     \"X-Custom-Header\": \"value\"\n   }\n }\n}

","contentUpdatedAt","Wed, 28 Jan 2026 21:59:45 GMT","path","docs/webhooks","generatorLanguages","SHUBApiDetails","exploreUrl","https://explore.swaggerhub.com","currentToc",{"_13":14,"_46":47,"_40":48,"_19":20,"_49":50},"shubUrl","apiRenderer","TOGGLE","routingSettings",{"_42":43,"_44":45},"isTemplatePreview",false,"metaInfo",{"_36":37,"_38":39,"_40":41},"canonicalUrl","https://docs.paubox.com/paubox_email_api/docs/webhooks","pageUrl","http://docs.paubox.com/paubox_email_api/docs/webhooks","title","Webhooks | Paubox Email API | Docs + Quickstarts | Paubox","routing","browser","credentialsEnabled",true,"tableOfContentsId","ff0f6500-1375-45f2-8e2a-f2e5ad109597","Webhooks","children",[],"sections",{"_87":88,"_89":90},"currentProduct",{"_62":80,"_64":81,"_66":57,"_68":82,"_70":45,"_71":33,"_72":83,"_74":84,"_76":85,"_78":86},"currentProductRole","productSlug","paubox_email_api","products",[54,61],"isTemplate",{"_62":63,"_64":65,"_66":67,"_68":69,"_70":45,"_71":33,"_72":73,"_74":75,"_76":77,"_78":79},"id","9e53ae06-7014-4bc3-bc13-6bc9628fea47","name","Paubox Marketing API","slug","paubox_marketing_api","description","The public API for the Paubox Marketing HIPAA compliant email marketing solution.","canAccess","hidden","logoAttachmentId","57cae665-9278-4dc3-a4e5-2752a9df7e38","logoDarkModeAttachmentId","d972249e-0b8f-45ee-9698-4e855580100a","logoImageHref","https://portal.swaggerhub.com/services/api/attachments/57cae665-9278-4dc3-a4e5-2752a9df7e38","logoImageDarkModeHref","https://portal.swaggerhub.com/services/api/attachments/d972249e-0b8f-45ee-9698-4e855580100a","cfc33eb3-be1b-4f28-9962-29675d867f4b","Paubox Email API","Clear documentation to quickly send HIPAA compliant email via API. HITRUST certified since 2019.","8df2d227-2582-4146-a87a-d0a741f367d0","e2e751f0-f8b0-4d1b-886b-5617ec4a7759","https://portal.swaggerhub.com/services/api/attachments/8df2d227-2582-4146-a87a-d0a741f367d0","https://portal.swaggerhub.com/services/api/attachments/e2e751f0-f8b0-4d1b-886b-5617ec4a7759","page",{"_234":235,"_236":237,"_238":235,"_239":235},"items",[91],{"_40":92,"_66":92,"_93":94},"docs","tableOfContents",[95,96,97,98,99,100],{"_13":14,"_46":230,"_40":231,"_19":232,"_49":233},{"_13":14,"_46":226,"_40":227,"_19":228,"_49":229},{"_13":14,"_46":222,"_40":223,"_19":224,"_49":225},{"_13":14,"_46":47,"_40":48,"_19":20,"_49":221},{"_13":14,"_46":217,"_40":218,"_19":219,"_49":220},{"_13":101,"_46":102,"_40":81,"_103":104,"_19":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":115},"apiUrl","f1a4d55b-dc56-410c-8306-1fd0548e8796","url","https://api.swaggerhub.com/apis/paubox/transactional_email/1.0.0/swagger.json","docs/paubox-email-api-v-1-0-0","apiSpec","openapi-3.0.0","operations",[174,175,176,177,178,179,180,181,182],"schemas",[116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144],"asyncApiMessages",[],"asyncApiServers",[],{"_64":173},{"_64":172},{"_64":171},{"_64":170},{"_64":169},{"_64":168},{"_64":167},{"_64":166},{"_64":165},{"_64":164},{"_64":163},{"_64":162},{"_64":161},{"_64":160},{"_64":159},{"_64":158},{"_64":157},{"_64":156},{"_64":155},{"_64":154},{"_64":153},{"_64":152},{"_64":151},{"_64":150},{"_64":149},{"_64":148},{"_64":147},{"_64":146},{"_64":145},"TemplatedMessageRequest_data","MessageReceiptResponse_data","MessageReceiptResponse_data_message","ErrorResponse_errors","BulkSendResponse_messages","BulkSendRequest_data","SingleSendRequest_data","dynamic_templates_id_body","inline_response_200","dynamic_templates_body","TemplatedMessageHeaders","TemplatedMessage","TemplatedMessageRequest","DynamicTemplateListResponse","DynamicTemplateResponse","ClickData","DeliveryStatus","MessageDelivery","MessageReceiptErrorResponse","MessageReceiptResponse","ErrorResponse","BulkSendResponse","SingleSendResponse","Attachment","MessageContent","MessageHeaders","Message","BulkSendRequest","SingleSendRequest",{"_183":184,"_19":214,"_186":208,"_188":215,"_190":216},{"_183":184,"_19":211,"_186":208,"_188":212,"_190":213},{"_183":199,"_19":207,"_186":208,"_188":209,"_190":210},{"_183":199,"_19":202,"_186":187,"_188":205,"_190":206},{"_183":184,"_19":202,"_186":187,"_188":203,"_190":204},{"_183":199,"_19":193,"_186":187,"_188":200,"_190":201},{"_183":196,"_19":193,"_186":187,"_188":197,"_190":198},{"_183":192,"_19":193,"_186":187,"_188":194,"_190":195},{"_183":184,"_19":185,"_186":187,"_188":189,"_190":191},"method","POST","/templated_messages","tag","Dynamic Templates","summary","Send a dynamically templated message","operationId","sendTemplatedMessage","PATCH","/dynamic_templates/{id}","Update a dynamic template","updateDynamicTemplate","DELETE","Delete a dynamic template","deleteDynamicTemplate","GET","Get a dynamic template","getDynamicTemplate","/dynamic_templates","Create a dynamic template","createDynamicTemplate","List all dynamic templates","listDynamicTemplates","/message_receipt","Messages","Get email disposition","getMessageReceipt","/bulk_messages","Send multiple email messages (batch)","sendBulkMessages","/messages","Send a single email message","sendMessage","f0ea242b-c59a-45b8-a9d4-4c5c67fde9b2","Limits and Overage Rates","docs/limits-and-overage-rates",[],[],"c51dbd7b-4579-4d6f-862b-e920e35fd199","SMTP API","docs/smtp-api",[],"a11d1cd4-b756-4140-8e78-16cf17ab1031","Quickstart Guide","docs/quickstart",[],"28d3966c-b981-47dc-965f-368f66564f7f","General Information","docs/introduction",[],"number",1,"size",10,"totalElements","totalPages","user",{"_353":354},"portalName","Docs + Quickstarts | Paubox","portalCustomDomain","docs.paubox.com","portalSubdomain","paubox","gtmKey","GTM-5NKZSMP","landingPageData",{"_64":243,"_286":287,"_288":289,"_72":290,"_74":291,"_292":293,"_294":295,"_296":297,"_298":299,"_300":301,"_302":33,"_68":303,"_261":262,"_76":304,"_78":305,"_306":-7,"_307":-7,"_308":309,"_310":311,"_312":313,"_314":315},"organizationRole","highestRole","platformAdmin","previewMode","swaggerhubOrgName","templates","customDomainActive","swaggerhubOrgId","adfd628c-ccd9-4b69-b690-e198a3612882","footer",{"_263":45,"_264":265,"_266":267,"_268":-7,"_269":-7},"visible","links",[270,271,272,273,274],"text","© Paubox 2026","imageHref","imageDarkModeHref",{"_275":284,"_103":285},{"_275":282,"_103":283},{"_275":280,"_103":281},{"_275":278,"_103":279},{"_275":276,"_103":277},"label","Contact","https://www.paubox.com/contact-us","Customers","https://www.paubox.com/customer-stories","Security","https://www.paubox.com/security","Blog","https://www.paubox.com/blog","Pricing","https://www.paubox.com/pricing/paubox-email-api","faviconAttachmentId","414a6a9f-f202-40e4-8802-ccbdca8b173d","faviconDarkModeAttachmentId","2df91e18-4a1f-4775-809e-8d72083cbf28","fe656a9d-5328-4d86-8223-c1ebb9f33f94","82ff77bd-24a5-4600-b054-2014f4811605","illustrationImageAttachmentId","a69979ed-ab76-4074-b05b-84341fced146","illustrationImageDarkModeAttachmentId","c3fc8029-e4b2-4b5a-b1e4-88b1f7776eb9","fontName","Lato","accentColor","#0247dc","accentColorDarkMode","#ffffff","offline",[316,317,318,319],"https://portal.swaggerhub.com/services/api/attachments/fe656a9d-5328-4d86-8223-c1ebb9f33f94","https://portal.swaggerhub.com/services/api/attachments/82ff77bd-24a5-4600-b054-2014f4811605","heroImageHref","heroImageDarkModeHref","illustrationImageHref","https://portal.swaggerhub.com/services/api/attachments/a69979ed-ab76-4074-b05b-84341fced146","illustrationImageDarkModeHref","https://portal.swaggerhub.com/services/api/attachments/c3fc8029-e4b2-4b5a-b1e4-88b1f7776eb9","faviconHref","https://portal.swaggerhub.com/services/api/attachments/414a6a9f-f202-40e4-8802-ccbdca8b173d","faviconDarkModeHref","https://portal.swaggerhub.com/services/api/attachments/2df91e18-4a1f-4775-809e-8d72083cbf28",["SingleFetchClassInstance",342],["SingleFetchClassInstance",338],["SingleFetchClassInstance",334],["SingleFetchClassInstance",320],{"_321":322,"_64":323,"_324":325,"_49":326},"$$mdtype","Tag","p","attributes",{},[327],["SingleFetchClassInstance",328],{"_321":322,"_64":329,"_324":330,"_49":331},"Link",{"_332":333},[227],"href","paubox_email_api/docs/quickstart/",{"_321":322,"_64":323,"_324":335,"_49":336},{},[337],"Get up and running in minutes with Paubox Email API.",{"_321":322,"_64":323,"_324":339,"_49":340},{},[341],"Learn how to send HIPAA compliant email on the Paubox platform.",{"_321":322,"_64":343,"_324":344,"_49":345},"Heading",{"_352":235},[346],["SingleFetchClassInstance",347],{"_321":322,"_64":348,"_324":349,"_49":350},"strong",{},[351],"Paubox Developer Docs","level","profile","https://profile.id.smartbear.com/","appMode","portal","locale","en","notification","bugsnagApiKey","15dbd45f0b623fe8ba7056c9f5a3165d","editorKey","eyJhbGciOiJFUzI1NiJ9.eyJleHAiOjE4MjcyNzM1OTksImp0aSI6IjRkMGE0Zjc3LTk0YTktNGRjNC1iZjdiLTNmYTM3MjcwYjUxYiIsImRpc3RyaWJ1dGlvbkNoYW5uZWwiOlsic2giLCJkcnVwYWwiXSwid2hpdGVMYWJlbCI6dHJ1ZSwiZmVhdHVyZXMiOlsiRFJVUCIsIkRPIiwiRlAiLCJTQyIsIlRPQyIsIlRQTCIsIlBPRSIsIkNDIiwiTUYiLCJTRUUiLCJCT1giLCJDTVQiLCJUQyIsIlJIIl0sInZjIjoiZDllZWYyZTgifQ.8pGGsuIWKK_0gvsKin0Qr4v6saiOpRVl1cp_xfPNPu7zh2Q4R2mGHr3WCjvk0VR1y7m3djHEIc2tNMx5poHrww","env","prod","flags",{"_433":45,"_434":45,"_435":33,"_436":45,"_437":33,"_438":33,"_439":45,"_440":45,"_441":45,"_442":45,"_443":33,"_444":235,"_445":45,"_446":33,"_447":448,"_449":45,"_450":45,"_451":45,"_452":33,"_453":45,"_454":33,"_455":33,"_456":45,"_457":45,"_458":45,"_459":33,"_460":33,"_461":45},{"_353":354,"_431":432},"layout","default","amplitudeData",{"_427":428,"_429":430},"portalMetaName","mode","system","sessionMode","preferredColorScheme","license",{"_13":426},"apiHubPlan",{"_404":45,"_405":406,"_407":408,"_409":410},"appConfig",{"_389":390,"_391":24,"_392":393,"_394":395,"_396":397,"_398":399,"_400":401,"_402":403},"apiHubUrl","https://app.swaggerhub.com/hub/adfd628c-ccd9-4b69-b690-e198a3612882","cutoverDate","isExternalLoginEnabled","isCustomDomain","platformUiUrl","https://platform.smartbear.com","shubExploreUrl","pactflowAppUrl","https://app.pactflow.io","reflectAppUrl","https://auth.reflect.run/oauth2/authorize?response_type=code&client_id=7taop7pbojn2nlj536vshmmgn&redirect_uri=https%3A%2F%2Fapp.reflect.run%2Foauth%2Fsso&identity_provider=SmartBear","shubAppUrl","https://app.swaggerhub.com","portalRootUrl","https://{portalname}.portal.swaggerhub.com","portalAppUrl","","catalogAppUrl","https://catalog.swaggerhub.com","platformManaged","gates",{"_418":45,"_419":45,"_420":45,"_421":45,"_422":45,"_423":45,"_424":45,"_425":45},"productMeters",{"_411":412,"_413":415,"_416":417},"templateMeters",{"_411":412,"_413":414},"limit",2147483647,"currentUsage",0,6,"warningThreshold",1610612735,"sbFooterRemoved","subdomainEditingEnabled","customDomainEnabled","consumerSideOnline","requestAccessEnabled","attachmentManagerEnabled","privateAndHiddenProductsEnabled","collaborationEnabled","paid","amplitudeApiKey","79eb0fee7c605a4e0d80273236e85fa9","portalData",{},"proxyToken","6e3db571-5f8b-4315-b549-2e36f7172feb","api-hub-agent-force","api-hub-ai-based-standardization-rules-generation","api-hub-ai-diff-based-generation","api-hub-graph-ql-specification-support","api-hub-insight-hub-integration","api-hub-new-features-for-3-1-editor","api-hub-next-editor-for-2-0-and-3-0","api-hub-rollout-reflect-app-switcher","api-hub-rollout-reflect-landing-page","api-hub-spectral-js-evaluator","api-hub-standardization-page-redesign","api-hub-welcome-bar-message-index","catalog-access-control","catalog-recent-apis","catalog-trial-redirects","http://catalog.swaggerhub.com?orgId={orgId}","halo-ai-api-hub-api-design-diff","halo-ai-api-hub-mcp-server-generation","halo-ai-api-hub-open-api-design-generation","halo-ai-api-hub-open-api-generation-by-implementation","portal-permanent-markdown-editing-support","swagger-ai-agents-support","swagger-github-app-integration","swagger-new-panel-mechanism","swagger-products-rebrand","swagger-studio-elements-support","swagger-studio-import-stoplight","swagger-studio-oas-3-1-domains","swagger-studio-oas-3-2-support"]