Bulk create events

Queues up to 1000 events for asynchronous creation instead of creating them one at a time. It returns a bulk operation id immediately, before any individual event has been created. Poll that id with Bulk event status, whose response reports the operation’s status, timestamps, and (once it completes) a per-item error list and a log of the events it created. A batch item that fails schema validation returns a differently shaped {status: 400, errors: [...]} body.

Authorizations

X-SHARED-SECRET

required

stringheader

Parameters

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Creator group to use for this operation. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.

Request Body

application-x-www-form-urlencoded

Array<object>

object

eventCode

required

The code representing the event to be logged

string

Example

reachLevel20

playerId

required

Unique id of the player that the event pertains to

string

Example

player_8f2c41d0

referralCode

Optional code for the creator that referred this user

string

Example

popcornfrog

Responses

200

Event Bulk Operation created successfully

application/json

ID of the generated bulk operation

string

400

Bad request

application/json

object

code

CodeNotInGroup: Creator group is private, and specified code is not linked to it
InvalidGroup: No creator group was found with the specified groupId
InvalidAuthCode: AuthCode provided is not valid
ExpiredAuthCode: AuchCode provided has expired
ReferralNexusNotFound: No Nexus was found to match the provided referral code
BountyNotFound: No bounty was found with the specified bountyId
CreatorNotFound: No creator found with the specified creatorId
InvalidEventCode: No event found with the specifed event code

string

Allowed values: InvalidGroup CodeNotInGroup InvalidAuthCode ExpiredAuthCode ReferralNexusNotFound BountyNotFound MemberNotFound InvalidEventCode UnknownError

message

string

POST

/event/bulk

const url = 'https://api.nexus.gg/v1/bounties/event/bulk?groupId=V1StGXR8_Z5jdHi6B1LiO';
const options = {
  method: 'POST',
  headers: {
    'X-SHARED-SECRET': 'nexus_sk_your_key_here',
    'Content-Type': 'application-x-www-form-urlencoded'
  },
  body: '[ { "eventCode": "reachLevel20", "playerId": "player_8f2c41d0", "referralCode": "popcornfrog" } ]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://api.nexus.gg/v1/bounties/event/bulk?groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'Content-Type: application-x-www-form-urlencoded' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here' \
  --data '[ { "eventCode": "reachLevel20", "playerId": "player_8f2c41d0", "referralCode": "popcornfrog" } ]'

Example

2ixlNNFdJh-9scoXek80w

Example

{
  "code": "InvalidGroup",
  "message": "Invalid Group ID: V1StGXR8_Z5jdHi6B1LiO"
}