Package com.sinch.sdk.domains.conversation.models.v1.webhooks

Interface Webhook

public interface Webhook
Represents a destination for receiving callbacks from the Conversation API.

  • Method Details

    • getAppId

      String getAppId()
      The app that this webhook belongs to.
      Returns:
      appId

    • getClientCredentials

      ClientCredentials getClientCredentials()
      Get clientCredentials
      Returns:
      clientCredentials

    • getId

      String getId()
      The ID of the webhook.
      Returns:
      id
      Read Only
      This field is returned by the server and cannot be modified

    • getSecret

      String getSecret()
      Optional secret be used to sign contents of webhooks sent by the Conversation API. You can then use the secret to verify the signature.
      Returns:
      secret

    • getTarget

      String getTarget()
      The target url where events should be sent to. Maximum URL length is 742. The conversation-api.*.sinch.com subdomains are forbidden.
      Returns:
      target

    • getTargetType

      WebhookTargetType getTargetType()
      Get targetType
      Returns:
      targetType

    • getTriggers

      List<WebhookTrigger> getTriggers()
      An array of triggers that should trigger the webhook and result in an event being sent to the target url. Refer to the list of Webhook Triggers for a complete list.
      Returns:
      triggers

    • builder

      static Webhook.Builder builder()
      Getting builder
      Returns:
      New Builder instance