WebhookEndpointCreated

  • createdAt
    Type: stringFormat: date-time
    required

    When PayrollKit registered the endpoint.

  • eventTypes
    Type: array of "resource.changed" 1… unique!enum
    const:  
    resource.changed
    required

    Notification types sent to this endpoint.

  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required

    PayrollKit webhook endpoint ID.

  • signingSecret
    Type: string
    read-only
    required

    Opaque signing secret returned in the original registration response and an exact idempotent replay. Store the full value unchanged and use its UTF-8 bytes as the HMAC-SHA256 key. It is absent from list responses and URL-conflict errors.

  • status
    const:  
    active
    required

    The endpoint is registered and receives new deliveries.

  • url
    Type: stringFormat: uri
    required

    Public HTTPS URL receiving notifications.