Retrieve a Webhook Subscription

GET 
/v1/webhook-subscriptions/:id

Retrieve a Webhook Subscription

Request

Path Parameters

id stringrequired

Id of the Webhook Subscription.

Responses

200

Successfully retrieves a Webhook Subscription

application/json

Schema

Schema

data object
id string
events WebhookEventsEnum[]
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, donation.hosted.payment_received]
url website
secret string
createdAt date-time
updatedAt date-timenullable
deletedAt date-timenullable
object string

Example (from schema)

{
  "data": {
    "id": "webhooksubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "events": [
      "validation_request.approved"
    ],
    "url": "https://example.com/my-webhook-handler",
    "secret": "string",
    "createdAt": "2024-03-08T11:45:00.867Z",
    "updatedAt": "2024-03-08T11:45:00.867Z",
    "deletedAt": "2024-03-08T11:45:00.867Z"
  },
  "object": "webhook_subscription"
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

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

404

The specified resource was not found

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}

Loading...