Package com.atlassian.crowd.plugin.rest.service.resource.server

Class WebhooksResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

com.atlassian.crowd.plugin.rest.service.resource.server.WebhooksResource

@Path("webhook")
public class WebhooksResource
extends AbstractResource

Webhook management resource

Since:

v2.7

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

request, uriInfo

Constructor Summary

Constructors

Constructor	Description
WebhooksResource(WebhooksController webhooksController)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getWebhook(String id)
javax.ws.rs.core.Response	registerWebhook(WebhookEntity webhookEntity, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	registerWebhookWithSimpleBody(String endpointUrl)
javax.ws.rs.core.Response	unregisterWebhook(String id)

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

getApplicationName, getBaseUri, setApplicationName, setRequest, setUriInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebhooksResource

@Inject
public WebhooksResource(WebhooksController webhooksController)

Method Details

registerWebhook

@POST
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
public javax.ws.rs.core.Response registerWebhook(WebhookEntity webhookEntity,
 @Context
 javax.ws.rs.core.UriInfo uriInfo)
                                          throws InvalidWebhookEndpointException

Throws:

InvalidWebhookEndpointException

registerWebhookWithSimpleBody

@POST
@Consumes("text/plain")
@XsrfProtectionExcluded
public javax.ws.rs.core.Response registerWebhookWithSimpleBody(String endpointUrl)
                                                        throws InvalidWebhookEndpointException

Throws:

InvalidWebhookEndpointException

getWebhook

@GET
@Produces({"application/xml","application/json"})
@Path("{webhookId}")
public javax.ws.rs.core.Response getWebhook(@PathParam("webhookId")
 String id)
                                     throws WebhookNotFoundException,
ApplicationPermissionException

Throws:

WebhookNotFoundException

ApplicationPermissionException

unregisterWebhook

@DELETE
@Path("{webhookId}")
public javax.ws.rs.core.Response unregisterWebhook(@PathParam("webhookId")
 String id)
                                            throws WebhookNotFoundException,
ApplicationPermissionException

Throws:

WebhookNotFoundException

ApplicationPermissionException