# Lockers WebHook APIs

The Webhook APIs enable event-driven communication by delivering real-time notifications when specific events occur. Webhook configurations define:
- The event types to subscribe to
- The target endpoint URL where notifications are delivered
- The authorization details required for secure communication

Once configured, event notifications are triggered and pushed to the registered endpoint whenever the subscribed events occur.
  
- Event notifications are delivered to the configured endpoint when subscribed events occur
- Only events explicitly configured in the webhook are triggered
- Each webhook configuration is uniquely identified by webHookConfigID
- Updates to a webhook configuration immediately affect subsequent event notifications
- Deleted webhook configurations stop receiving event notifications


Version: 0.1

## Servers

```
https://api-dev.sendpro360.pitneycloud.com/webhook
```

```
https://api-qa.sendpro360.pitneycloud.com/webhook
```

Sandbox Server for Webhook API's
```
https://api-sandbox.sendpro360.pitneybowes.com/webhook
```

Production Server for Webhook API's (uses live data)
```
https://api.sendpro360.pitneybowes.com/webhook
```

## Security

### basicAuth

Type: http
Scheme: basic

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Lockers WebHook APIs](https://docs.sendpro360.pitneycloud.com/_bundle/openapi/webhooklocker.yaml)

## Webhook

APIs for managing webhook configurations and event subscriptions. These APIs support operations such as retrieving supported events, creating webhook configurations, fetching webhook details, updating configurations, and deleting webhooks.

### Get Applicable Event list for webhook configuration

 - [GET /api/v1/events](https://docs.sendpro360.pitneycloud.com/openapi/webhooklocker/webhook/getevents.md): This operation gets the events details

### Create Webhook configuration

 - [POST /api/v1/webhookConfig](https://docs.sendpro360.pitneycloud.com/openapi/webhooklocker/webhook/postwebhook.md): Webhook provides the mechanism to push locker events as they occur. With help of this user would be able to receive events as they are generated and is received to the end user. This operation creates a webhook configuration. It needs details of events for which webhook tracking is required also the URL with its authorization details to which the locker events be pushed.

### Get All webhooks

 - [GET /api/v1/webhookConfig](https://docs.sendpro360.pitneycloud.com/openapi/webhooklocker/webhook/getallwebhook.md): This operation gets all the configured webhook and its details.

### Update Webhook

 - [PUT /api/v1/webhookConfig/{webHookConfigID}](https://docs.sendpro360.pitneycloud.com/openapi/webhooklocker/webhook/putwebhook.md): This operation updates the webhook details

### Get Webhook details by Id

 - [GET /api/v1/webhookConfig/{webHookConfigID}](https://docs.sendpro360.pitneycloud.com/openapi/webhooklocker/webhook/getwebhook.md): This operation gets the webhook details

### Delete Webhook

 - [DELETE /api/v1/webhookConfig/{webHookConfigID}](https://docs.sendpro360.pitneycloud.com/openapi/webhooklocker/webhook/deletewebhook.md): This operation delete the webhook