Package software.xdev.brevo.model

Class CreateWebhook

java.lang.Object
software.xdev.brevo.model.CreateWebhook
public class CreateWebhook extends Object
CreateWebhook

  • Field Details

  • Constructor Details

    • CreateWebhook

      public CreateWebhook()

  • Method Details

    • url

      public CreateWebhook url(@Nonnull String url)

    • getUrl

      @Nonnull public String getUrl()
      URL of the webhook
      Returns:
      url

    • setUrl

      public void setUrl(@Nonnull String url)

    • description

      public CreateWebhook description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Description of the webhook
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • events

      public CreateWebhook events(@Nonnull List<CreateWebhook.EventsEnum> events)

    • addEventsItem

      public CreateWebhook addEventsItem(CreateWebhook.EventsEnum eventsItem)

    • getEvents

      @Nonnull public List<CreateWebhook.EventsEnum> getEvents()
      - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed` - Possible values for type **Transactional** and channel **SMS** #### `accepted`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`, `subscribe`,`sent`,`blacklisted`,`skip` - Possible values for type **Marketing** channel **SMS** #### `sent`,`delivered`,`softBounce`,`hardBounce`,`unsubscribe`,`reply`, `subscribe`,`skip`
      Returns:
      events

    • setEvents

      public void setEvents(@Nonnull List<CreateWebhook.EventsEnum> events)

    • type

      public CreateWebhook type(@Nullable CreateWebhook.TypeEnum type)

    • getType

      @Nullable public CreateWebhook.TypeEnum getType()
      Type of the webhook
      Returns:
      type

    • setType

      public void setType(@Nullable CreateWebhook.TypeEnum type)

    • channel

      public CreateWebhook channel(@Nullable CreateWebhook.ChannelEnum channel)

    • getChannel

      @Nullable public CreateWebhook.ChannelEnum getChannel()
      channel of webhook
      Returns:
      channel

    • setChannel

      public void setChannel(@Nullable CreateWebhook.ChannelEnum channel)

    • domain

      public CreateWebhook domain(@Nullable String domain)

    • getDomain

      @Nullable public String getDomain()
      Inbound domain of webhook, required in case of event type `inbound`
      Returns:
      domain

    • setDomain

      public void setDomain(@Nullable String domain)

    • batched

      public CreateWebhook batched(@Nullable Boolean batched)

    • getBatched

      @Nullable public Boolean getBatched()
      Batching configuration of the webhook, we send batched webhooks if its true
      Returns:
      batched

    • setBatched

      public void setBatched(@Nullable Boolean batched)

    • auth

      public CreateWebhook auth(@Nullable Object auth)

    • getAuth

      @Nullable public Object getAuth()
      Authentication header to be send with the webhook requests
      Returns:
      auth

    • setAuth

      public void setAuth(@Nullable Object auth)

    • headers

      public CreateWebhook headers(@Nullable List<Object> headers)

    • addHeadersItem

      public CreateWebhook addHeadersItem(Object headersItem)

    • getHeaders

      @Nullable public List<Object> getHeaders()
      Get headers
      Returns:
      headers

    • setHeaders

      public void setHeaders(@Nullable List<Object> headers)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string