Rupt API

https://www.rupt.dev/api

Admin

Rupt is an API platform that uses advanced device identification, browser fingerprinting, and...

Tokens:400

Snippets:3

Trust Score:6.4

Update:2 months ago

Show doc for...

Tokens:

Raw

### challenge.initiated

Source: https://www.rupt.dev/api/v3/webhooks

Fires when a challenge is created for a user. The payload includes the account identifier and a summary of the challenge object.

```APIDOC
## Webhook: challenge.initiated

### Description
Fires when a challenge is created for a user.

### Payload
- **event** (String) - The event name: "challenge.initiated"
- **account** (String) - The account identifier
- **challenge** (Object) - The challenge object
  - **id** (String) - Unique identifier
  - **status** (String) - Current status
  - **code** (String) - Challenge code
  - **type** (String) - Challenge type
  - **reasons** (String[]) - List of reasons
  - **createdAt** (Date) - Creation timestamp
  - **updatedAt** (Date) - Last update timestamp

### Payload Example
{
  "event": "challenge.initiated",
  "account": "String",
  "challenge": {
    "id": "String",
    "status": "String",
    "code": "String",
    "type": "String",
    "reasons": ["String"],
    "createdAt": "Date",
    "updatedAt": "Date"
  }
}
```

--------------------------------

### Challenge Initiated Webhook Payload

Source: https://www.rupt.dev/api/v3/webhooks

The JSON structure for the challenge.initiated event, containing account details and the associated challenge object.

```JavaScript
{
  event: "challenge.initiated",
  account: String,
  challenge: {
    id: String,
    status: String,
    code: String,
    type: String,
    reasons: String[],
    createdAt: Date,
    updatedAt: Date,
  }
}
```

Tokens:

Raw