-
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.EventNameValues: eMAILRECEIVED,nEWEMAIL,nEWCONTACT,nEWATTACHMENT,eMAILOPENED,eMAILREAD
public enumWebhookDto.MethodHTTP method that your server endpoint must listen for Values: gET,hEAD,pOST,pUT,pATCH,dELETE,oPTIONS,tRACE
-
Field Summary
Fields Modifier and Type Field Description private final OffsetDateTimeupdatedAtprivate final BooleanbasicAuthprivate final OffsetDateTimecreatedAtprivate final WebhookDto.EventNameeventNameprivate final UUIDidprivate final UUIDinboxIdprivate final WebhookDto.Methodmethodprivate final Stringnameprivate final StringpayloadJsonSchemaprivate final Stringurlprivate final UUIDuserId
-
Constructor Summary
Constructors Constructor Description WebhookDto(OffsetDateTime updatedAt, Boolean basicAuth, OffsetDateTime createdAt, WebhookDto.EventName eventName, UUID id, UUID inboxId, WebhookDto.Method method, String name, String payloadJsonSchema, String url, UUID userId)
-
Method Summary
Modifier and Type Method Description final OffsetDateTimegetUpdatedAt()final BooleangetBasicAuth()final OffsetDateTimegetCreatedAt()final WebhookDto.EventNamegetEventName()final UUIDgetId()final UUIDgetInboxId()final WebhookDto.MethodgetMethod()final StringgetName()final StringgetPayloadJsonSchema()final StringgetUrl()final UUIDgetUserId()-
-
Constructor Detail
-
WebhookDto
WebhookDto(OffsetDateTime updatedAt, Boolean basicAuth, OffsetDateTime createdAt, WebhookDto.EventName eventName, UUID id, UUID inboxId, WebhookDto.Method method, String name, String payloadJsonSchema, String url, UUID userId)
- Parameters:
basicAuth- Does webhook expect basic authentication?createdAt- When the webhook was createdid- ID of the WebhookinboxId- The inbox that the Webhook will be triggered bymethod- HTTP method that your server endpoint must listen forname- Name of the webhookpayloadJsonSchema- Deprecated.url- URL of your server that the webhook will be sent to.userId- User ID of the Webhook
-
-
Method Detail
-
getUpdatedAt
final OffsetDateTime getUpdatedAt()
-
getBasicAuth
final Boolean getBasicAuth()
-
getCreatedAt
final OffsetDateTime getCreatedAt()
-
getEventName
final WebhookDto.EventName getEventName()
-
getInboxId
final UUID getInboxId()
-
getMethod
final WebhookDto.Method getMethod()
-
getPayloadJsonSchema
final String getPayloadJsonSchema()
-
-
-
-