> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/configuration/outbound-webhooks.md).
# Outbound Webhooks
Outbound webhook configuration for event notifications.
## GET /outbound-webhooks/events
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Outbound Webhooks","description":"Outbound webhook configuration for event notifications."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OutboundWebhookEventCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OutboundWebhookEventDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"OutboundWebhookEventDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"The event type identifier","readOnly":true},"displayName":{"type":"string","description":"The display name for the event type","readOnly":true}},"required":["id","type","displayName"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/outbound-webhooks/events":{"get":{"operationId":"OutboundWebhooksController_getAvailableEvents","parameters":[],"responses":{"200":{"description":"Returns a list of available event types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookEventCollectionDto"}}}}},"tags":["Outbound Webhooks"]}}}}
```
## GET /outbound-webhooks/{outboundWebhookId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Outbound Webhooks","description":"Outbound webhook configuration for event notifications."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/outbound-webhooks/{outboundWebhookId}":{"get":{"operationId":"OutboundWebhooksController_findOne","parameters":[{"name":"outboundWebhookId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an `OutboundWebhook`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookDto"}}}}},"tags":["Outbound Webhooks"]}}}}
```
## DELETE /outbound-webhooks/{outboundWebhookId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Outbound Webhooks","description":"Outbound webhook configuration for event notifications."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ErrorDto":{"type":"object","properties":{"statusCode":{"type":"number","readOnly":true},"message":{"type":"object","readOnly":true},"error":{"type":"string","readOnly":true}},"required":["statusCode","message","error"]}}},"paths":{"/outbound-webhooks/{outboundWebhookId}":{"delete":{"operationId":"OutboundWebhooksController_deleteOutboundWebhook","parameters":[{"name":"outboundWebhookId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an `OutboundWebhook`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookDto"}}}},"403":{"description":"Returns an `ErrorDto` in case there is not enough privileges to perform this action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorDto"}}}},"404":{"description":"OutboundWebhook not found"}},"tags":["Outbound Webhooks"]}}}}
```
## PATCH /outbound-webhooks/{outboundWebhookId}
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Outbound Webhooks","description":"Outbound webhook configuration for event notifications."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OutboundWebhookPatchableDto":{"type":"object","properties":{"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]}}},"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/outbound-webhooks/{outboundWebhookId}":{"patch":{"operationId":"OutboundWebhooksController_updateOutboundWebhook","parameters":[{"name":"outboundWebhookId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"The `OutboundWebhook` to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookPatchableDto"}}}},"responses":{"200":{"description":"Returns an `OutboundWebhook`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.
"}},"tags":["Outbound Webhooks"]}}}}
```
## GET /outbound-webhooks
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Outbound Webhooks","description":"Outbound webhook configuration for event notifications."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OutboundWebhookCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OutboundWebhookDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}},"paths":{"/outbound-webhooks":{"get":{"operationId":"OutboundWebhooksController_findAll","parameters":[{"name":"displayName","required":false,"in":"query","description":"Filter by outbound webhook display name","schema":{"type":"string"}},{"name":"url","required":false,"in":"query","description":"Filter by outbound webhook url","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":false,"in":"query","schema":{"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter by status","schema":{}},{"name":"eventTypes","required":false,"in":"query","description":"Filter by outbound webhook event types","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an `OutboundWebhookCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookCollectionDto"}}}}},"tags":["Outbound Webhooks"]}}}}
```
## POST /outbound-webhooks
>
```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Outbound Webhooks","description":"Outbound webhook configuration for event notifications."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OutboundWebhookDto":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the outbound webhook","readOnly":true},"displayName":{"type":"string","description":"The display name of the outbound webhook"},"url":{"type":"string","description":"The URL of the outbound webhook (HTTPS required in production)"},"eventTypes":{"type":"array","description":"The event types that the outbound webhook is subscribed to","items":{"type":"string","enum":["user.created","user.updated","user.deleted","purchase.created","booking.created","order.confirmed","order.canceled","membership-enrollment.created","event.created","event.updated","event-signup.created","event-signup.canceled"]}},"status":{"type":"string","description":"The status of the outbound webhook","enum":["ACTIVE","INACTIVE"]},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["id","displayName","url","eventTypes","status","errors","_links"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/outbound-webhooks":{"post":{"operationId":"OutboundWebhooksController_createOutboundWebhook","parameters":[],"requestBody":{"required":true,"description":"The `OutboundWebhook` to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookDto"}}}},"responses":{"201":{"description":"Returns an `OutboundWebhook`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OutboundWebhookDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.
"}},"tags":["Outbound Webhooks"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.podplay.app/api/configuration/outbound-webhooks.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.