1. Webhooks
Pigeon API // Staging
  • Introduction
  • Authentication
  • Integrations
  • Using Third-Party Cloud Storage
  • Requests
    • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
    • Close Request
      POST
  • Documents
    • Documents
    • Get Document
      GET
    • Delete Document
      DELETE
    • List Request Documents
      GET
    • Delete Request Documents
      DELETE
    • List Request Item Documents
      GET
    • Download Document
      GET
    • Download Request Documents
      GET
    • Download Request Item Documents
      GET
  • Templates
    • Templates
    • List Templates
    • Create Template
    • Get Template
    • Update Template
    • Delete Template
    • List Organization Templates
  • RequestItems
    • Request Items
    • Create Request Item
    • List Request Items
    • Get Request Item
    • Update Request Item
    • Delete Request Item
    • Verify Request Item
  • Webhooks
    • Webhooks
    • Create Webhook Subscription
      POST
    • List Webhook Subscriptions
      GET
    • Get Webhook Subscription
      GET
    • Update Webhook Subscription
      PATCH
    • Delete Webhook Subscription
      DELETE
    • Get Webhook Signing Secret
      GET
  • Users
    • Get Current User
    • List Users
    • List Organization users
    • Get User
  • Contacts
    • List Contacts
    • Create or Update Contact
    • List Organization Contacts
  • Teams
    • List Teams
    • Get Team
  • ScheduledReminders
    • Create Scheduled Reminder
    • List Scheduled Reminders
    • Get Scheduled Reminder
    • Update Scheduled Reminder
    • Delete Scheduled Reminder
  • Attachments
    • List Attachments
    • Create Attachment
    • Get Attachment
  • Escalations
    • Create Escalations
    • List Escalations
    • Get Escalation
    • Update Escalation
    • Delete Escalation
  • Forms
    • Get Form
    • Delete Form
    • List Forms
    • Create Form
  • Schemas
    • AuthMethod
    • Body_handler_attachments_post
    • Body_handler_forms_post
    • ButtonStyle
    • CollaboratorPublic
    • ConnectionProvider
    • CreateDocGen
    • CreateESignatureObject
    • CreateEscalation
    • CreateQuestionObject
    • CreateRecipientPostParams
    • CreateRequestItem
    • CreateRequestPostParams
    • CreateRequestRecipient
    • CreateScheduledNotificationRecipient
    • CreateScheduledReminder
    • CreateTemplatePostParams
    • CreateWebhookWithoutOrg
    • CustomerDocumentPublic
    • DocumentNotFound
    • DocumentPublic
    • DocumentType
    • DocumentWithItemPublic
    • FilenameFormat
    • FormFieldPublic
    • FormFieldType
    • FormNotFound
    • FormPublic
    • HTTPValidationError
    • HeroStyle
    • ItemType
    • Language
    • OrganizationNotFound
    • QuestionType
    • RecipientPublic
    • RequestAttachmentPublic
    • RequestItemNotFound
    • RequestItemPublic
    • RequestNotFound
    • RequestPublic
    • RequestRecipientPublic
    • RequestStatus
    • ScheduledNotificationNotFound
    • ScheduledNotificationPublic
    • SendMethod
    • SessionPayloadPublic
    • SortOrder
    • TeamNotFound
    • TeamPublic
    • TemplateNotFound
    • TemplatePublic
    • UpdateEscalation
    • UpdateRequestItem
    • UpdateRequestPostParams
    • UpdateScheduledNotificationRecipient
    • UpdateScheduledReminder
    • UpdateTemplate
    • UpdateWebhook
    • UserNotFound
    • UserPublic
    • UserRole
    • ValidationError
    • WebhookNotFound
    • WebhookPublic
    • WebhookPublicWithSecret
    • WebhookTopic
  1. Webhooks

Create Webhook Subscription

POST
/webhooks
Create a new webhook subscription.

Request

Body Params application/jsonRequired

Example
{
    "endpoint": "http://example.com",
    "topics": [
        "request.created"
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/webhooks' \
--header 'Content-Type: application/json' \
--data '{
    "endpoint": "http://example.com",
    "topics": [
        "request.created"
    ]
}'

Responses

🟢200OK
application/json
Successful Response
Bodyapplication/json

Example
{
    "endpoint": "http://example.com",
    "topics": [
        "request.created"
    ],
    "id": "string",
    "signing_secret": "string"
}
🟠422Parameter Error
Modified at 2026-06-30 16:05:10
Previous
Webhooks
Next
List Webhook Subscriptions
Built with