Package dev.vality.swag_webhook_events.api

Interface WebhookApi

All Known Implementing Classes:

WebhookApiController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2024-02-26T07:25:16.040246332Z[Etc/UTC]")
@Validated
public interface WebhookApi

Method Summary

Modifier and Type	Method	Description
default WebhookApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<Void>	notifyWebhookEvent(String contentSignature, @Valid Event event)	POST /webhook : Notify of an event

Method Details

getDelegate

default WebhookApiDelegate getDelegate()

notifyWebhookEvent

@RequestMapping(method=POST,
                value="/webhook",
                produces="application/json; charset=utf-8",
                consumes="application/json")
default org.springframework.http.ResponseEntity<Void> notifyWebhookEvent(@RequestHeader(value="Content-Signature",required=true)
String contentSignature,
@Valid @RequestBody
@Valid Event event)

POST /webhook : Notify of an event

Parameters:

contentSignature - Message signature formed according to the above rules (required)

event - Data from an event that occurred in the platform (required)

Returns:

Notification processed (status code 200) or Target resource not found (status code 404)