-
public final class WebhookDtoRepresentation of a webhook for an inbox. The URL specified will be using by MailSlurp whenever an email is received by the attached inbox. A webhook entity should have a URL that points to your server. Your server should accept HTTP/S POST requests and return a success 200. MailSlurp will retry your webhooks if they fail. See https://api.mailslurp.com/schemas/webhook-payload for the payload schema.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumWebhookDto.MethodHTTP method that your server endpoint must listen for Values: gET,hEAD,pOST,pUT,pATCH,dELETE,oPTIONS,tRACE
public enumWebhookDto.EventNameWebhook trigger event name Values: eMAILRECEIVED,nEWEMAIL,nEWCONTACT,nEWATTACHMENT,eMAILOPENED,eMAILREAD,bOUNCE,bOUNCERECIPIENT,nEWSMS
-
Field Summary
Fields Modifier and Type Field Description private final UUIDidprivate final UUIDuserIdprivate final BooleanbasicAuthprivate final Stringurlprivate final WebhookDto.Methodmethodprivate final StringpayloadJsonSchemaprivate final OffsetDateTimecreatedAtprivate final OffsetDateTimeupdatedAtprivate final Stringnameprivate final UUIDinboxIdprivate final WebhookDto.EventNameeventNameprivate final WebhookHeadersrequestHeaders
-
Constructor Summary
Constructors Constructor Description WebhookDto(UUID id, UUID userId, Boolean basicAuth, String url, WebhookDto.Method method, String payloadJsonSchema, OffsetDateTime createdAt, OffsetDateTime updatedAt, String name, UUID inboxId, WebhookDto.EventName eventName, WebhookHeaders requestHeaders)
-
Method Summary
Modifier and Type Method Description final UUIDgetId()final UUIDgetUserId()final BooleangetBasicAuth()final StringgetUrl()final WebhookDto.MethodgetMethod()final StringgetPayloadJsonSchema()final OffsetDateTimegetCreatedAt()final OffsetDateTimegetUpdatedAt()final StringgetName()final UUIDgetInboxId()final WebhookDto.EventNamegetEventName()final WebhookHeadersgetRequestHeaders()-
-
Constructor Detail
-
WebhookDto
WebhookDto(UUID id, UUID userId, Boolean basicAuth, String url, WebhookDto.Method method, String payloadJsonSchema, OffsetDateTime createdAt, OffsetDateTime updatedAt, String name, UUID inboxId, WebhookDto.EventName eventName, WebhookHeaders requestHeaders)
- Parameters:
id- ID of the WebhookuserId- User ID of the WebhookbasicAuth- Does webhook expect basic authentication?url- URL of your server that the webhook will be sent to.method- HTTP method that your server endpoint must listen forpayloadJsonSchema- Deprecated.createdAt- When the webhook was createdname- Name of the webhookinboxId- The inbox that the Webhook will be triggered by.eventName- Webhook trigger event name
-
-
Method Detail
-
getBasicAuth
final Boolean getBasicAuth()
-
getMethod
final WebhookDto.Method getMethod()
-
getPayloadJsonSchema
final String getPayloadJsonSchema()
-
getCreatedAt
final OffsetDateTime getCreatedAt()
-
getUpdatedAt
final OffsetDateTime getUpdatedAt()
-
getInboxId
final UUID getInboxId()
-
getEventName
final WebhookDto.EventName getEventName()
-
getRequestHeaders
final WebhookHeaders getRequestHeaders()
-
-
-
-