Skip to main content

Past Events

GET 

/events/v2/history/webhooks/:name

Search handled events by specified params

Generate JWT

Request

Path Parameters

    name stringrequired

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[a-zA-Z0-9_-]+$

Query Parameters

    event string
    from date-time
    to date-time
    limit integer

    Possible values: >= 1 and <= 100

    Default value: 100
    offset integer
    Default value: 0
    responseCode integer

    Possible values: >= 100 and <= 599

    minAttempts integer
    status string

    Possible values: [NEW, IN_PROCESS, DELIVERED, CANCELED, FAILED]

Responses

Returns on success

Schema

  • Array [

  • id uuid

    UUIDv1 of current event. It's different with source event id

    Example: 413f13e3-684e-223f-2247-0963feaa3351

    source

    object

    Source event from an application

    id uuid

    UUIDv1 of incomming event. Can be generated on client side or automatically server side

    Example: 166ae306-50ff-11e9-8647-d663bd873d93
    project Events_ProjectName (string)

    Project name

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[a-zA-Z0-9_-]+$

    Example: pvc
    event Events_EventName (string)required

    Event name

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[a-zA-Z0-9_-]+$

    Example: broadcast-start
    payload object

    Payload which described in project config. HTTP method must be POST, PUT, PATCH or DELETE

    Example: {"foo":"bar"}
    attempts integer

    How many attempts it already made

    Example: 3
    lastResponseCode integer

    Last HTTP code returned from webhook endpoint

    Example: 200
    lastResponseTime number

    How long was las response (ms)

    Example: 25
    status string

    Current status of this task

    Possible values: [NEW, IN_PROCESS, DELIVERED, CANCELED, FAILED]

    lastError string

    Last error was occurred

    Example: Remote endpoint returned 500 HTTP code
    created date-time

    Timestamp when the task was started

    Example: 2019-07-21T17:32:28.000Z
    webhookName Events_WebhookName (string)

    Webhook name

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[a-zA-Z0-9_-]+$

    Example: pvc-broadcast-events
  • ]

Loading...