WebhookController

Attach a WebHook URL to a phone number

Get notified whenever a phone number receives an SMS via a WebHook URL.

post/phone/numbers/{phoneNumberId}/webhooks

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/phone/numbers/{phoneNumberId}/webhooks
  • Auth: API key in header x-api-key

Path parameters

phoneNumberIdstring uuid required

Request body

urlstring required

Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. See docs.mailslurp.com/webhooks for event payload documentation.

namestring nullable

Optional name for the webhook

eventName'EMAIL_RECEIVED' | 'NEW_AI_TRANSFORM_RESULT' | 'NEW_EMAIL' | 'NEW_CONTACT' | 'NEW_ATTACHMENT' | 'EMAIL_OPENED' | 'EMAIL_READ' | 'DELIVERY_STATUS' | 'BOUNCE' | 'BOUNCE_RECIPIENT' | 'NEW_SMS' | 'NEW_GUEST_USER' nullable

Optional webhook event name. Default is EMAIL_RECEIVED and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name.

requestBodyTemplatestring nullable

Template for the JSON body of the webhook request that will be sent to your server. Use Moustache style {{variableName}} templating to use parts of the standard webhook payload for the given event.

aiTransformIdstring uuid nullable

AI Transform ID to apply to the webhook event and send a payload matching transform output schema

useStaticIpRangeboolean nullable

Use static IP range when calling webhook endpoint

ignoreInsecureSslCertificatesboolean nullable

Ignore insecure SSL certificates when sending request. Useful for self-signed certs.

tagsstring[] nullable

Optional list of tags

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.