Package pw.chew.clickup4j.api.entities

Interface Webhook

All Known Implementing Classes:
WebhookImpl
public interface Webhook

Webhook

A webhook is a URL that is called when a certain event happens.

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      The ID of the webhook.
      Returns:
      never-null webhook ID

    • getUserId

      int getUserId()
      The user ID of the user who created the webhook.
      Returns:
      user ID

    • getWorkspaceId

      int getWorkspaceId()
      The workspace this webhook belongs to.
      Returns:
      workspace ID

    • getEndpoint

      @NotNull @NotNull String getEndpoint()
      The endpoint ClickUp will send webhooks to.
      Returns:
      endpoint URL

    • getClientId

      @NotNull @NotNull String getClientId()
      The client id of the webhook.
      Returns:
      client ID

    • getEvents

      @NotNull @NotNull List<String> getEvents()
      The events this webhook is listening for.
      Returns:
      never-null, but potentially empty, list of events

    • getTaskId

      @Nullable @Nullable String getTaskId()
      Returns the Task ID of the task this webhook is listening for.
      This may be null, meaning the webhook is either listening elsewhere, or globally.
      Returns:
      task ID, or null

    • getListId

      @Nullable @Nullable String getListId()
      Returns the TaskList ID of the list this webhook is listening for.
      This may be null, meaning the webhook is either listening elsewhere, or globally.
      Returns:
      list ID, or null

    • getFolderId

      @Nullable @Nullable String getFolderId()
      Returns the folder ID of the folder this webhook is listening for.
      This may be null, meaning the webhook is either listening elsewhere, or globally.
      Returns:
      folder ID, or null

    • getSpaceId

      @Nullable @Nullable String getSpaceId()
      Returns the Space ID of the list this webhook is listening for.
      This may be null, meaning the webhook is either listening elsewhere, or globally.
      Returns:
      space ID, or null

    • getHealth

      Webhook.Health getHealth()
      Returns the Health of the webhook.
      This is one of the enum constants: active, failing, or suspended.
      If the webhook is failing, you can see the fail count with getFailCount().
      Returns:
      never-null health

    • getFailCount

      int getFailCount()
      Returns the number of times the webhook has failed.
      0 means the webhook is active.
      Returns:
      fail count

    • getSecret

      @NotNull @NotNull String getSecret()
      Returns the secret of the webhook, to be used when verifying the webhook.
      Returns:
      never-null secret

    • delete

      Requester<Void> delete()
      Delete this webhook.
      Returns:
      nothing

    • getClickUp4j

      @NotNull @NotNull ClickUp4j getClickUp4j()
      This ClickUp4j instance.
      Returns:
      never-null instance