> For the complete documentation index, see [llms.txt](https://eventx-hq.gitbook.io/knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eventx-hq.gitbook.io/knowledge-base/api-doc/event-webhook.md).

# Event Webhook

## GET /public-api/v1/event/{eventId}/webhook/all

> List all webhooks for an event

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/webhook/all":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1},"rawData":{"type":"object","properties":{"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1}},"additionalProperties":false}},"required":["id","url","actions","rawData"],"additionalProperties":false}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}}],"tags":["Event Webhook"],"operationId":"getAllEventWebhook","summary":"List all webhooks for an event"}}}}
```

## POST /public-api/v1/event/{eventId}/webhook

> Create a webhook subscription for an event

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/webhook":{"post":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1},"rawData":{"type":"object","properties":{"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1}},"additionalProperties":false}},"required":["id","url","actions","rawData"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1}},"required":["url","actions"],"additionalProperties":false}}}},"tags":["Event Webhook"],"operationId":"createEventWebhook","summary":"Create a webhook subscription for an event"}}}}
```

## Permanently delete a webhook

> Hard delete. The webhook is permanently removed from the database.

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/webhook/{webhookId}":{"delete":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"tags":["Event Webhook"],"operationId":"deleteEventWebhookById","summary":"Permanently delete a webhook","description":"Hard delete. The webhook is permanently removed from the database."}}}}
```

## PATCH /public-api/v1/event/{eventId}/webhook/{webhookId}

> Partially update a webhook

```json
{"openapi":"3.0.0","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"https://esaas-api.eventx.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/webhook/{webhookId}":{"patch":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1},"rawData":{"type":"object","properties":{"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1}},"additionalProperties":false}},"required":["id","url","actions","rawData"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"webhookId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"},"actions":{"type":"array","items":{"type":"string","enum":["attendee-create","attendee-update","attendee-delete","attendee-check-in","attendee-check-out"]},"minItems":1}},"additionalProperties":false}}}},"tags":["Event Webhook"],"operationId":"patchEventWebhookById","summary":"Partially update a webhook"}}}}
```