POST /api/v1/webhook_endpoints

Creates a new webhook endpoint object.

application/json

Body

  • description string

    A human-readable description of the webhook endpoint.

  • events array[string]

    List of event types to subscribe to. If not provided, subscribes to all events. Use "*" to subscribe to all events. Available event types: policy.active, policy.active.media, policy.cancelled, policy.reactivated, application.created, application.started, application.complete, application.expired, application.ineligible, application.manual_review, application.manual_review_approved, assignment.active, assignment.cancelled, certificate.flagged, certificate.approved, certificate.denied, invoice.charge_card_failed, invoice.charge_card_succeeded, category_code.added

  • url string Required

    The URL of the webhook endpoint.

Responses

  • 201 application/json

    Returns the webhook endpoint object if the post succeeded.

    Hide response attributes Show response attributes object
    • created integer(int64)

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • description string

      Optional human-readable description of the endpoint.

    • id string

      Unique identifier for the object.

    • secret string

      Webhook secret which you can use to verify that the webhook is from 1099Policy. Read more about how to use the webhook secret to verify the webhook signature in our documentation here.

    • url string

      The URL of the webhook endpoint.
POST /api/v1/webhook_endpoints 
curl \
 --request POST 'https://api.1099policy.com/api/v1/webhook_endpoints' \
 --header "Content-Type: application/json" \
 --data '{"description":"string","events":["application.complete","application.ineligible","policy.active"],"url":"string"}'
Request examples 
{
  "description": "string",
  "events": [
    "application.complete",
    "application.ineligible",
    "policy.active"
  ],
  "url": "string"
}
Response examples (201) 
{
  "created": 1646818364,
  "description": "string",
  "id": "string",
  "secret": false,
  "url": "https://example.com/my/webhook/endpoint"
}