Package io.mailtrap.api.webhooks

Interface Webhooks

All Known Implementing Classes:
WebhooksImpl
public interface Webhooks

  • Method Details

    • createWebhook

      CreateWebhookResponse createWebhook(long accountId, CreateWebhookRequest request)
      Create a new webhook for the account. The response includes the signing_secret used to verify webhook signatures (only returned on creation).
      Parameters:
      accountId - unique account ID
      request - webhook configuration
      Returns:
      created webhook including the signing secret

    • getAllWebhooks

      ListWebhooksResponse getAllWebhooks(long accountId)
      List all webhooks for the account.
      Parameters:
      accountId - unique account ID
      Returns:
      webhooks

    • getWebhook

      WebhookResponse getWebhook(long accountId, long webhookId)
      Get a single webhook by ID.
      Parameters:
      accountId - unique account ID
      webhookId - webhook ID
      Returns:
      webhook details

    • updateWebhook

      WebhookResponse updateWebhook(long accountId, long webhookId, UpdateWebhookRequest request)
      Update an existing webhook.
      Parameters:
      accountId - unique account ID
      webhookId - webhook ID
      request - fields to update
      Returns:
      updated webhook

    • deleteWebhook

      WebhookResponse deleteWebhook(long accountId, long webhookId)
      Permanently delete a webhook.
      Parameters:
      accountId - unique account ID
      webhookId - webhook ID
      Returns:
      the deleted webhook