com.gigs.paymentLink.updated

  • Name
    object
    Type
    string
    required
    Description

    Type of object is always event.

    Allowed values: event
  • Name
    id
    Type
    string
    required
    Description

    Unique identifier for the event.

    Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
  • Name
    data
    Type
    PaymentLink
    PREVIEW
    required
    Description
    A payment link provides a URL that renders a page for the users to pay for an invoice.
  • Name
    datacontenttype
    Type
    string
    required
    Description

    The RFC 2046 content-type.

    Example: "application/json"
    Default: application/json
  • Name
    previousData
    Type
    object
    Description

    Present only for events of type *.updated. Contains the values fields in the schema had prior to the update.

    This field is the result of a shallow diff of the previous schema (i.e., if a nested field has changed, then the entire object will be included).

  • Name
    project
    Type
    string
    required
    Description

    Unique identifier for the project where the event occurred.

    Example: "gigs"
  • Name
    source
    Type
    string
    required
    Description

    URI identifying the event source.

    Example: "https://api.gigs.com"
    Default: https://api.gigs.com
  • Name
    specversion
    Type
    string
    required
    Description

    The CloudEvents spec version.

    Example: "1.0"
    Default: 1.0
  • Name
    time
    Type
    string
    required
    Description

    Time when the event occurred.

    Example: "2022-03-16T14:12:42Z"
  • Name
    type
    Type
    string
    required
    Description

    Type is always com.gigs.paymentLink.updated.

    Allowed values: com.gigs.paymentLink.updated
  • Name
    version
    Type
    string
    required
    Description

    API version used to serialize the data and the event itself.

    Default: 2024-12-20

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "paymentLink",
    "id": "pml_0SNlurA049MEWV1x2CfC8u8im5xU",
    "canceledAt": "2024-08-14T19:40:34Z",
    "completedAt": "2024-08-14T19:40:34Z",
    "createdAt": "2024-08-14T19:38:34Z",
    "ebanx": {
      "redirectUrl": "https://example.com"
    },
    "invoice": "inv_0SNlurA049MEWV1QTRqvd18YuG25",
    "paymentUrl": "https://api.ebanx.com/ws/redirect/execute?hash=64f2",
    "status": "active",
    "type": "ebanx"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.paymentLink.updated",
  "version": "2024-12-20"
}