Create a Webhook Subscription

POST 
/v1/webhook-subscriptions

Create a Webhook Subscription. Specify the event types to subscribe to and the URL where the notifications will be sent, the URL must be https.

Request

application/json

Body

required

eventsWebhookEventsEnum (string)[]

Events to subscribe to

Possible values: [validation_request.approved, validation_request.rejected, agent_verification.pending_review, agent_verification.pending_user_verification, agent_verification.approved, agent_verification.rejected, monitoring_subscription.updated, eligibility_subscription.updated, validation_submission.created, validation_submission.succeeded, validation_submission.failed, validation_submission.updated, donation.hosted.payment_received, donation.created, donation.settled, donation.disbursed, donation.payment_successful, donation.cancelled, donation.reassigned]

urlwebsiterequired
URL to which notifications should be sent (https only)
Example: https://example.com/webhooks

Responses

200

Successfully created a Webhook Subscription

application/json

Schema

Schema

data

object

idstring

Example: webhooksubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

eventsWebhookEventsEnum (string)[]

Possible values: [validation_request.approved, validation_request.rejected, agent_verification.pending_review, agent_verification.pending_user_verification, agent_verification.approved, agent_verification.rejected, monitoring_subscription.updated, eligibility_subscription.updated, validation_submission.created, validation_submission.succeeded, validation_submission.failed, validation_submission.updated, donation.hosted.payment_received, donation.created, donation.settled, donation.disbursed, donation.payment_successful, donation.cancelled, donation.reassigned]

urlwebsite

Example: https://example.com/my-webhook-handler

secretstring

createdAtdate-time

updatedAtdate-timenullable

deletedAtdate-timenullable
objectstring
Example: webhook_subscription

Example (from schema)

{
  "data": {
    "id": "webhooksubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "events": [
      "validation_request.approved"
    ],
    "url": "https://example.com/my-webhook-handler",
    "secret": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "deletedAt": "2024-07-29T15:51:28.071Z"
  },
  "object": "webhook_subscription"
}

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

IncorrectParams

400 Incorrect Parameters

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}