Package org.oxerr.viagogo.client.rescu.resource.webhook

Interface WebhookResource

@Path("/{version}/webhooks")
public interface WebhookResource

Method Summary

Modifier and Type	Method	Description
Webhook	createWebhook(Webhook webhook)	Create a webhook
void	deleteWebhook(Integer webhookId)	Delete a webhook
Webhook	getWebhook(Integer webhookId)	Get a webhook
Webhooks	getWebhooks(Integer page, Integer pageSize, String sort)	List webhooks
void	ping(Integer webhookId)	Ping a webhook
Webhook	updateWebhook(Integer webhookId, Webhook webhook)	Update a webhook

Method Details

getWebhooks

@GET
@Produces("application/json")
@Consumes("application/json")
Webhooks getWebhooks(@QueryParam("page")
 Integer page,
 @QueryParam("page_size")
 Integer pageSize,
 @QueryParam("sort")
 String sort)
              throws IOException,
ViagogoException

List webhooks

List webhooks for the authenticated user.

Parameters:

page - Specifies which page of data to retrieve.

pageSize - Set custom page sizes on response.

sort - Determines the ordering of items. A comma-separated string containing resource_version.

Returns:

all webhooks on the viagogo platform.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

createWebhook

@POST
@Produces("application/json")
@Consumes("application/json")
Webhook createWebhook(Webhook webhook)
               throws IOException,
ViagogoException

Create a webhook

Parameters:

webhook - the webhook.

Returns:

the created webhook.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

getWebhook

@GET
@Path("/{webhookId}")
Webhook getWebhook(@PathParam("webhookId")
 Integer webhookId)
            throws IOException,
ViagogoException

Get a webhook

Parameters:

webhookId - the webhook ID.

Returns:

the webhook.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

updateWebhook

@PATCH
@Path("/{webhookId}")
@Produces("application/json")
@Consumes("application/json")
Webhook updateWebhook(@PathParam("webhookId")
 Integer webhookId,
 Webhook webhook)
               throws IOException,
ViagogoException

Update a webhook

Parameters:

webhookId - the webhook ID.

webhook - the webhook.

Returns:

the updated webhook.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

deleteWebhook

@DELETE
@Path("/{webhookId}")
void deleteWebhook(@PathParam("webhookId")
 Integer webhookId)
            throws IOException,
ViagogoException

Delete a webhook

Parameters:

webhookId - the webhook ID.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception

ping

@POST
@Path("/{webhookId}/ping")
@Produces("application/json")
@Consumes("application/json")
void ping(@PathParam("webhookId")
 Integer webhookId)
   throws IOException,
ViagogoException

Ping a webhook

Triggers a request to be sent to your webhook. Call this endpoint to test your webhook.

Parameters:

webhookId - the webhook ID.

Throws:

IOException - indicates I/O exception

ViagogoException - indicates business exception