Interface EventDestinationsService


public interface EventDestinationsService
Event Destinations Service
  • Method Details

    • list

      List webhooks

      List all webhooks for a given app as specified by the App ID.

      Parameters:
      appId - The unique ID of the app. You can find this on the [Sinch Dashboard](https://dashboard.sinch.com/convapi/apps). (required)
      Returns:
      EventDestinationsListResponse
      Throws:
      ApiException - if fails to make API call
    • create

      EventDestination create(EventDestinationCreateRequest eventDestinationCreateRequest) throws ApiException
      Create a new webhook

      Creates a webhook for receiving callbacks on specific triggers. You can create up to 5 webhooks per app.

      Parameters:
      eventDestinationCreateRequest - Required. The Webhook to create (required)
      Returns:
      EventDestination
      Throws:
      ApiException - if fails to make API call
    • delete

      void delete(String eventDestinationId) throws ApiException
      Delete an existing webhook

      Deletes a webhook as specified by the webhook ID.

      Parameters:
      eventDestinationId - The unique ID of the webhook. (required)
      Throws:
      ApiException - if fails to make API call
    • get

      EventDestination get(String eventDestinationId) throws ApiException
      Get a webhook

      Get a webhook as specified by the webhook ID.

      Parameters:
      eventDestinationId - The unique ID of the webhook. (required)
      Returns:
      EventDestination
      Throws:
      ApiException - if fails to make API call
    • update

      EventDestination update(String eventDestinationId, EventDestination eventDestination) throws ApiException
      Update an existing webhook

      Updates an existing webhook as specified by the webhook ID.

      Parameters:
      eventDestinationId - The unique ID of the webhook. (required)
      eventDestination - Required. The Webhook to update (required)
      Returns:
      EventDestination
      Throws:
      ApiException - if fails to make API call