Package se.bjurr.bitbucketcloud.gen.api

Interface HookEventsApi

@Path("/hook_events") @Generated(value="org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date="2025-07-17T16:07:08.420911588+02:00[Europe/Stockholm]", comments="Generator version: 7.14.0") public interface HookEventsApi
Represents a collection of functions to interact with the API endpoints.

  • Method Details

    • hookEventsGet

      @GET @Produces("application/json") SubjectTypes hookEventsGet()
      Returns the webhook resource or subject types on which webhooks can be registered. Each resource/subject type contains an `events` link that returns the paginated list of specific events each individual subject type can emit. This endpoint is publicly accessible and does not require authentication or scopes. Example: ``` $ curl https://api.bitbucket.org/2.0/hook_events { \"repository\": { \"links\": { \"events\": { \"href\": \"https://api.bitbucket.org/2.0/hook_events/repository\" } } }, \"team\": { \"links\": { \"events\": { \"href\": \"https://api.bitbucket.org/2.0/hook_events/team\" } } }, \"user\": { \"links\": { \"events\": { \"href\": \"https://api.bitbucket.org/2.0/hook_events/user\" } } } } ```
      Returns:
      A mapping of resource/subject types pointing to their individual event types.

    • hookEventsSubjectTypeGet

      @GET @Path("/{subject_type}") @Produces("application/json") PaginatedHookEvents hookEventsSubjectTypeGet(@PathParam("subject_type") String subjectType)
      Returns a paginated list of all valid webhook events for the specified entity. This is public data that does not require any scopes or authentication. Example: NOTE: The following example is a truncated response object for the `team` `subject_type`. We return the same structure for the other `subject_type` objects. ``` $ curl https://api.bitbucket.org/2.0/hook_events/team { \"page\": 1, \"pagelen\": 30, \"size\": 21, \"values\": [ { \"category\": \"Repository\", \"description\": \"Whenever a repository push occurs\", \"event\": \"repo:push\", \"label\": \"Push\" }, { \"category\": \"Repository\", \"description\": \"Whenever a repository fork occurs\", \"event\": \"repo:fork\", \"label\": \"Fork\" }, ... { \"category\": \"Repository\", \"description\": \"Whenever a repository import occurs\", \"event\": \"repo:imported\", \"label\": \"Import\" } ] } ```
      Parameters:
      subjectType - A resource or subject type.
      Returns:
      A paginated list of webhook types available to subscribe on.